Sistema financeiro

Project name 💻

Technologies • Getting Started • API Endpoints • Collaborators

Simple description of what your project do or how to use it.

💻 Technologies

• NodeJS
• MySQL

🚀 Getting started

Here you describe how to run your project locally

Prerequisites

Here you list all prerequisites necessary for running your project. For example:

• NodeJS
• Git 2

Cloning

How to clone your project

git clone https://github.com/Gguife/finance-fullstack-api

Config .env variables

Use the .env.example as reference to create your configuration file .env with your AWS Credentials

DB_HOTS=localhost
DB_NAME=seu_banco_de_dados
DB_USER=seu_usuario
DB_PASS=sua_senha

Starting

How to start your project

1. cd finance-fullstack-api
2. install all dependencies with npm install or yarn install
3. npm run dev or yarn dev

📍 API Endpoints

Here you can list the main routes of your API, and what are their expected request bodies. ​

route	Model	Description
GET /users	users	See all users
POST /users	users	Create user
PUT /users/:id	users	Update user
DELETE /users/:id	users	Remove user
GET /goals	goals	See all goals
POST /goals	goals	Create goal
PUT /goals/:id	goals	Update goal
DELETE /goals/:id	goals	Remove goal
GET /categories	categories	See all categories
POST /categories	categories	Create category
PUT /categories/:id	categories	Update category
DELETE /categories/:id	categories	Remove category
GET /transactions	transactions	See all transactions
POST /transactions	transactions	Create transaction
PUT /transactions/:id	transactions	Update transaction
DELETE /transactions/:id	transactions	Remove transaction

🤝 Collaborators

Special thank you for all people that contributed for this project.

_{Guilherme Gomes}