Set up new project

1. Clone this repo. Run:

   git clone git@github.com:taptima/skeleton-front-end.git <my-app-name>

2. Make sure you have Node.js (^16.13.0) and Yarn (^1.22.0) installed.
3. Install the dependencies. Run:

   yarn

4. Set up your new project using CLI. Run and follow the instructions:

   yarn plop

Develop

1. Install the dependencies. Run:

   yarn

2. Set up environment variables. See list of pre-configured environment variables bellow. Run:

   yarn configure

   Note: .env.local overwrite .env
3. Start the development server (see additional info about this feature). Run:

   yarn dev

4. Open http://localhost:3000 in your browser.

Publish

1. Install the dependencies. Run:

   yarn

2. Make the production build. Run:

   yarn build

3. Start server (see additional info about this feature). Run:

   yarn start

Pre-configured environment variables

1. NEXT_PUBLIC_API_BASE_URL — URL used for any API calls.
2. LOCAL_API_BASE_URL - URL for API calls on server side that used to avoid request roundtrip and DNS resolving.
   Example: http://localhost:8000, or with docker network http://api
3. NEXT_PUBLIC_ASSETS_VERSION — version of public assets. Can be used to reset browser cache of any assets.
4. NEXT_PUBLIC_SENTRY_DSN — used to log errors to Sentry requires .sentryclirc.

Sentry

1. Add NEXT_PUBLIC_SENTRY_DSN to .env file
2. sentry-cli login — to login through browser or enter auth token. .sentryclirc file will be created in your home directory, you can move it to project directory.
3. Fill defaults.project field in sentry.properties file