• Table of Contents
• ❗ Code of Conduct
• 🙌🏻 How to Contribute
• 🏃 How to Run - Dev mode
  • Requirements
  • Env files
  • Database
  • Backend
  • Frontend
• 🏃 How to Run - with docker
• Usage
• 📝 License
• Contributors ✨

We expect everyone to abide by our Code of Conduct. Please read it. 🤝

Check out our Contributing Guide for information on contributing.

To run the project you will need the requirements listed below and configure the env files as described in the example. In the next section How to run - with docker you can find instructions on how to run the entire project with docker.

1. Node
2. Docker
3. Env files

An .env file must be present in each app folder (frontend and backend) and it's also needed the .env in the root folder of the project in order to create the database. This files are already provisioned as an example (.env.example) in the respective folders and you can use and edit them. In order to use the example, please remove the suffix .example from the file name.

The frontend .env file have the parameter named SECRET that is required by next-auth on the frontend and to generate it just run the following command openssl rand -base64 32 in the shell then paste it in the .env file.

Since the database is the only app required to run in dev mode. You need to build it running the follow command docker-compose up -d mongo in the project's root folder. The mongo image is downloaded, built and the database is created with the name that is passed as described in the env file parameter called DB_NAME. After the container is built, the init script that's inside the database folder runs in order to create a user to manage and connect to the database from the backend.

To run this application for the first time run npm i inside the backend folder. Once you have installed the dependencies, simply run: npm run start:dev

To run this application for the first time run npm i inside the frontend folder. Once you have installed the dependencies, simply run: npm run dev

In order to run the whole project with docker you need to prepare the .env.example file that is present in the root folder of the project and from there run the following command: docker-compose up -d

The backend will run on http://localhost:BACKEND_PORT and the frontend on http://localhost:3000. Be aware the frontend root page ("/") is the landing page and has not yet been built so you must manually enter one of the following routes:

• "/dashboard": dashboard
• "/auth": authentication

You must register to access the dashboard page

Licensed under the MIT License.

Thanks goes to these wonderful people (emoji key):

Nuno Caseiro 💻 ⚠️ 🚇 📖

This project follows the all-contributors specification. Contributions of any kind welcome!