Offical backend of CougarCS.
yarn
yarn server
.env
file in the root project folder.NEW_RELIC_ENABLED=false
) in development..env
file include these:PORT
SENDGRID_API_KEY
CALENDAR_ID
CALENDAR_API_KEY
SHEET_API
RECAPTCHA_SECRET_KEY
STRIPE_API_KEY
SENTRY_URL
SEND_EMAIL
NOTION_TOKEN
NOTION_TUTOR_DB
YOUTUBE_API_KEY
YOUTUBE_PLAYLIST_ID
COUGARCS_CLOUD_URL
COUGARCS_CLOUD_ACCESS_KEY
COUGARCS_CLOUD_SECRET_KEY
NEW_RELIC_LICENSE_KEY
NEW_RELIC_APP_NAME
SUPABASE_URL
SUPABASE_KEY
Development Docker:
docker build -t <image-name> -f Dockerfile.dev .
docker run -dp <docker-port>:<external-port> --env-file .env <image-name>
Production Docker:
docker build -t <image-name> .
docker run -dp <docker-port>:<external-port> --env-file .env <image-name>
yarn run eslint-check
to check linting issues in the code.yarn run eslint-fix
to auto-lint the code.secretsSONAR_ORG
SONAR_PROJ_KEY
SONAR_TOKEN
yarn test
yarn test:coverage
server.js
is the starting point of the applicationsrc/api/routes/
has the routes of the applicationssrc/config/app.js
sets up the middlewaressrc/utils/api/calls.js
has the api logicsrc/utils/
has config for logger and cachingtest
has the unit and the intergeration tests