Skip to content

Run Guidelines

Rueben van der Westhuizen edited this page Jul 18, 2024 · 6 revisions

Run Guidelines

Package installation

  • Run npm install in the root directory.
  • For Linux: IF you get dependency issues, install those dependencies and then run again. -e.g. if you get something like this error: An unhandled exception occurred: Cannot find module @rollup/rollup-linux-x64-gnu. npm has a bug related to... then run npm install @rollup/rollup-linux-x64-gnu

Running the Project

Running the entire project

  • Ensure you have pasted the relevant .env file in the Backend directory.
  • To run the whole project: Run npm start in the root directory.

Running Frontend only

  • Change directory to Frontend: cd Frontend
  • Run ng serve

Buidling and Running Frontend offline(PWA)

  • Change directory to Frontend: cd Frontend
  • Build the application npm run build or ng build --configuration production
  • serve http-server dist/frontend/browser or HTTP equivalent
  • press F12 go to application and tick offline

Running Backend only

  • Ensure you have pasted the relevant .env file in the Backend directory.
  • Change directory to Backend: cd Backend
  • Run nest start

Having issues anywhere else?

-When in doubt, npm install