✔️ To-dos App - is a backend application that serves an API to register users and manage to-do tasks.
-
Users can register themselves providing:
- name
- username
- password
-
Users can:
- create user usecase and controller
- create to-do use case and controller
- find all to-dos by user id
- update to-do by id
- mark to-do as done
- delete to-do by id
This project has only a backend application.
💡 All requests needs the backend server up to work.
Before you begin, you will need to have the following tools installed on your machine: Git, Node.js, Yarn & docker-compose Besides that, is good to have an editor to visualize and navigate trough the code like VSCode
# Clone this repository
$ git clone git@github.com:henbalmant/to-dos-app-node-js.git
# Access the project folder with your terminal/cmd
$ cd to-dos-app-node-js
# Install all dependencies
$ yarn install
# Run docker-compose (sometimes you will need run with sudo)
$ docker-compose up -d
# Starts the development application
$ yarn dev
# The server will start on port:3000 - access http://localhost:3000
The following tools were used in the construction of the project:
Backend (NodeJS + TypeScript)
See package.json
- Editor: Visual Studio Code
- Markdown: StackEdit, Markdown Emoji
- Commit Conventional: Commitlint
- API Testing: Insomnia
- Fork the project.
- Create a new branch with your changes:
git checkout -b my-feature - Save your changes and create a commit message telling you what you did:
git commit -m "feature: My new feature" - Submit your changes:
git push origin my-feature
If you have any questions check this guide on how to contribute
Henrique Balmant 🚀
This project is under the license MIT.
Made with ❤️ by Henrique Balmant 👋🏽 Get in touch!