Project Name

Desafio-Back-end-Cubos-03

Description

This project was the third challange to create a RESTful API in Node.js with Postgres for bank-transactions.

Installation

1. Clone this repository: git clone git@github.com:PauloHartelt/Desafio-Back-end-Cubos-03.git
2. Navigate to the project directory: cd Desafio-Back-end-Cubos-03
3. Install dependencies: npm install
4. Run the project: npm run dev

How to Use

To use the API, simply send HTTP requests to the available endpoints.

Endpoints

Here are the endpoints available in the API:

• GET /user: Returns a list of all registered users.

• POST /user: Creates a new user based on the data provided in the request body.

• PUT /user: Updates information for the user on the data provided in the request body.

• POST /login: Creates a new acess token based on the data provided in the request body and log the user.

• GET /category: Returns a list of all registered categories.

• GET /transaction: Returns a list of all registered transactions of that user.

• GET /transaction/extract: Returns a list of all registered extracts of that user.

• GET /transaction/:id: Returns information for the user transaction with the specified ID.

• POST /transaction: Creates a new transaction based on the data provided in the request body.

• PUT /transaction/:id: Updates information for the transaction with the specified ID based on the data provided in the request body.

• DELETE /transaction/:id: Deletes the transaction with the specified ID.

To use the API, send HTTP requests to these endpoints using an HTTP client such as Postman, Insomnia or cURL.

Contributing

We welcome contributions to this project! To contribute, follow these steps:

1. Fork this repository
2. Create a branch with your feature: git checkout -b my-feature
3. Commit your changes: git commit -m 'My new feature'
4. Push to the branch: git push origin my-feature
5. Open a Pull Request

Contributors

Gabriel Magalhães	Paulo Hartelt

Contact

If you have any questions or suggestions about this project, feel free to contact me through my GitHub profile: @PauloHartelt.