Technologies Used   |    How to run the API   |    How to contribute   |    License

📚 About

It's an API that makes financial transactions.

Services:

• Create transaction
• Read transactions
• Delete transaction
• Read file and create transaction

⚒️ Technologies Used

• Node.js
• TypeScript
• Express
• Docker
• Postgres
• TypeORM
• Multer

🚀 How to run the API

🔸 Requirements

• NodeJS in its LTS version
• Visual Studio Code
• Dbeaver
• Docker
• Docker installation guide
• yarn

🔸 Commands

• Clone this repository

git clone https://github.com/RuthMaria/GoFinances-backend.git

• Install the postgres image on your docker container using port 5432 or another port

docker run --name gostack_postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

• Start postgres image

docker start gostack_postgres

• Open the Dbeaver and create a new connection with Postgres. Change the port to 5432 and in the password, you type "docker", as you have defined above when create a postgres image on docker.

• After that, create a new database in yout postgres connection inside Dbeaver. Write "gostack_desafio06" in the database name. For run the tests, create another database call "gostack_desafio06_test".

• Install dependencies

yarn

• Create the migrations

yarn typeorm migration:run

• Run the API

yarn dev:server

• Run the tests

yarn test

🎯 How to contribute

• Fork this repository,
• Create a branch with your feature: git checkout -b my-feature
• Commit your changes: git commit -m 'feat: My new feature'
• Push your branch: git push origin my-feature

📝 License

This project is under the MIT license. See the file LICENSE for more details.

---

Developed with ❤️ by Ruth Maria