Project Members:
- Dev Thakkar
- Jonathan Dow
- Rohan Sagar (rsagar@purdue.edu)
- Dongwon Kim
Folder Structure:
src/ - contains all the source code
src/index.ts - entry point for the application
src/controllers/ - contains api logic
src/config/ - contains all environment variables, database connection, etc.
src/models/ - defines the interfaces for api
src/routes/ - contains all the routes
src/utils/ - all general purpose functions that can be used anywhere in the application
dist/ - contains all compiled javascript code
Prettier is installed as a dev dependency. It will automatically format the code when you save a file. It will run automatically when npm run dev or npm run start is run. If you want to run it manually, run npm run prettier-format
- Clone the repository
- Replace all empty env variables with the correct values
- Run
npm installto install all the dependencies - Run
npm run devto start the application in development mode (automatically restarts the server when changes are made - uses nodemon) - Run
npm run startto start the application in production mode (does not restart the server when changes are made)