This is the main frontend repository for the software part of a P2 project created by SW2 group 8 at Aalborg University Copenhagen.
Copy .env.local.sample into .env.local and .env.sample into .env, and
add the credentials obtained from the Firebase project admin to it.
The Firebase Emulator Suite UI can be accessed at localhost:4000.
To start the Docker Compose project, run:
docker compose up -dor, when using JetBrains WebStorm, by running the Docker Compose run configuration.
Then, start a new shell session in the server container:
docker exec -it chess-teacher-front-end-server-1 /bin/zshThe first time the project is cloned, or when dependencies in package.json
or package-lock.json have changed, in the server container run:
npm installNow the development server can be started in the server container:
npm run devThe front end is now accessible at localhost:3000.
When code is pushed to the remote repository, the
Formatting And Linting workflow is run.
Therefore, check your code for errors before committing and pushing by running the tools in the server container
first:
npm run prettier && npx eslint .To check whether the project can be compiled for production, run the build command:
NODE_ENV=production npm run buildThen, start the production server with:
NODE_ENV=production npm run start # WARNING: THIS WILL USE THE PRODUCTION FIREBASE RESOURCES!After a finished development cycle, exit the server container and run:
docker compose down...