README.md

Concours Registration

Web application for Concours (DA-IICT Sports Festival) registrations.

Development Instructions

This application uses a NodeJS Express Server (server folder) and a ReactJS frontend (client folder) and uses yarn workspaces to manage intra dependencies. MongoDB is used for database operations and SendGrid is used to send emails.

You need Node & Yarn to run this application. Download them here - Node, Yarn.

You also need to setup .env files in both the client and server folders:

• For the client:

  REACT_APP_API_URL=#(Optional; defaults to http://localhost:5000) Your backend server url

• For the server:

  DB_URL=#mongodb url
  DB_NAME=#database name
  SENDGRID_API_KEY=#SendGrid API key
  PASSWORD=#password for registration admin

To run the development server of the client, use:

yarn client:start

To run the backend server in development, use:

yarn server:dev

Other Scripts Available:

• Building a production version of the client:

yarn client:build

• Building a production version of the server:

yarn server:build

• Starting the production version of the server:

yarn server:start