On this application you can:
- Register by creating an account.
- Login using your credentials.
- Create tasks by adding their title.
- Mark your tasks as completed.
- Update the tasks that are not marked as completed yet.
- Delete the tasks that have been marked as completed.
Verify if you have Yarn installed on your machine by running:
yarn --version
Verify if you have Docker installed on your machine by running:
docker --version
Once the repository is downloaded, place into the project folder and run the following command to install all the necessary dependencies:
yarn
Run the Docker daemon. If you are using a Unix based OS, you might need to add sudo keyword at the beginning of the comand. Alternatively, you can use the Docker Desktop Application to run the container.
docker-compose up -d
Now, you will have to create an .env file at the root of the project, and inside create the following variables:
# port
BACKEND_PORT=5001
# database
DB_HOST=localhost
DB_PORT=5432
DB_USER=postgres
DB_PASSWORD=postgres
DB_NAME=to-do-api
# jwt secret
JWT_SECRET=supersecret
# frontend port
FRONTEND_PORT=http://localhost:5173
Finally, use the following command to run the project:
yarn start:dev
In order for the application to work completely as intended, the Frontend application needs to be up and running. You can download the Frontend code from this [GitHub Repository](https://github.com/salvadorperezm/to-do-app).