Caffeine - API

This project has the purpose of developing myself as a back-end engineer.

It's a study project of registering coffee capsules. Such as:

• User creation - JWT authentication, being able to create and reset passwords.
• Coffee registration, saving information such as brand, coffee type, and the price in the purchase date.
• Holds inventory to register how many capsules have been consumed in the week.
• And when the users want to be notified when it is at the end of the box.

Currently, the application has:

• User authentication
• User list

Next features 🏗️:

• Coffee registration
• Inventory
• Notification
• Swagger - for documentation.

Project developed with:

• Node
• Typescript
• Express
• Mongodb

Test developed with:

• Jest

To run the project you need to install:

• Node
• Yarn or NPM (already installed with the node)
• Mongodb

To start it is necessary to rotate the mongo locally:

• mongod

Before starting the project you must install the dependencies:

• yarn

To start the project you have to run the commands:

yarn start

• This command to access http://localhost:3000

Say hello 👋

Since I'm aiming to learn more about back-end, any tips or suggestions are welcome. I would love to hear from you, feel free to open an issue or also a pull request.