- Frontend client:
http://localhost:3000/
. This is the default URL for the frontend client identified by theDEV_SERVER_HOST
and theDEV_SERVER_PORT
environment variables.
- ViteJS
- ReactJS v18
- React Router
- ReduxJS
- DS frontend package
- Vitest
- Ant Design v4+
- React Final Form
- Lodash
- DayJS
- CSS Modules (SCSS format)
- Yarn
- Install Node v18.16.0 or run
nvm use
if you have this package - Setup ESLint for preferred code editor
- Install yarn globally (https://yarnpkg.com/getting-started/install)
- Copy
.env.example
file and create.env.local
with required settings
APP_NAME
: general app name to identificate projectBACKEND_URL
: url for backend API requestsHOST_URL
: the host to the site, without campus subdomainsWEBSOCKET_HOST
: url for proxying web sockets in development modeWEBSOCKET_PROTOCOL
: the WebSocket protocol,ws://
without TSL andwss://
with TSLAPI_URL
: url prefix for API requests, helps to avoid duplication on each requestDEV_SERVER_PORT
: port for dev serverDEV_SERVER_HOST
: host for dev serverSTORAGE_KEY
: key used to identify application object properites in localStorageGOOGLE_TAG_ID
: Google Tag Manager IDCACHE_STATE_KEYS
: what to store, set empty or null to store all stateCACHE_STATE_PERSIST_KEYS
: persisted store information after "Clear" actionLIMIT
: default limit for resources with paginationSENTRY_ORG
: Sentry organizationSENTRY_PROJECT
: Sentry projectSENTRY_AUTH_TOKEN
: Sentry auth tokenSENTRY_DSN
: Sentry DSNSENTRY_ENVIRONMENT
: Sentry environmentSENTRY_RELEASE_VERSION
: Sentry release version
Install required packages:
yarn install
Run app in development mode:
yarn start
Run production build:
yarn build
Run ESlint and Stylelint checks:
yarn lint
Run ESlint and Stylelint checks and fix all fixable issues:
yarn lint:fix
Run Vitest test cases:
yarn test