GoFinances 💸

About   |    Technologies   |    How To Use   |    License   |    Author

About

NodeJS project developed on RocketSeat GoStack 13.0. This project is an API for a personal finance application, with register of incomes and outcomes by CSV files.

Technologies

This project was developed with the following technologies:

• NodeJS
• Typescript
• Express
• PostgreSQL
• TypeORM
• cors
• csv-parse

How To Use

To clone and run this application, you'll need installed on your computer:

• Git
• Node.js
• Yarn v1
• One instance of PostgreSQL

Obs.: I recommend using docker to create and run the PostgreSQL instance.

To run the server:

# Clone the repository
$ git clone https://github.com/rafacdomin/gofinances-api

# Create the instance of postgreSQL using docker
$ docker run --name GoFinancesPG -e POSTGRES_USER=postgres \
              -e POSTGRES_DB=gofinances -e POSTGRES_PASSWORD=docker \
              -p 5432:5432 -d postgres

# Go into the repository folder
$ cd gofinances-api

Make a copy of .env.example to .env and set YOUR enviroment variables

# Install dependencies
$ yarn

# Run the server
$ yarn dev:server

License

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

---

Author

Made with 💜 by Rafael Domingues 👋 Get in touch!