https://github.com/laurabeatris/gofinances-api
Rest API to manage financial transactions - Built with Express, TypeORM and Postgres
https://github.com/laurabeatris/gofinances-api
api backend express postgres rest rest-api typeorm typescript
Last synced: 3 months ago
JSON representation
Rest API to manage financial transactions - Built with Express, TypeORM and Postgres
- Host: GitHub
- URL: https://github.com/laurabeatris/gofinances-api
- Owner: LauraBeatris
- Created: 2020-05-17T16:41:44.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T02:36:02.000Z (over 2 years ago)
- Last Synced: 2025-03-17T05:44:27.167Z (3 months ago)
- Topics: api, backend, express, postgres, rest, rest-api, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 2.19 MB
- Stars: 14
- Watchers: 1
- Forks: 4
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Go Finances
> Store transactions and keep up to date with your balance
> [Click here to see the database model](https://dbdiagram.io/d/5ec2703039d18f5553ff5e91)
> [](https://insomnia.rest/run/?label=GoFinances%20API&uri=https%3A%2F%2Fraw.githubusercontent.com%2FLauraBeatris%2Fgofinances-api%2Fmaster%2F.github%2Fdocumentation.json)
[](https://github.com/LauraBeatris)
[](#)
[](https://github.com/LauraBeatris/gofinances-api/stargazers)
[](https://github.com/LauraBeatris/gofinances-api/network/members)
[](https://github.com/LauraBeatris/gofinances-api/graphs/contributors)
# :pushpin: Table of Contents
* [Features](#rocket-features)
* [Installation](#construction_worker-installation)
* [Getting Started](#runner-getting-started)
* [FAQ](#postbox-faq)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
# :rocket: Features
* 🌴 Transactions CRUD
* 📂 Import transactions from CSV files
# :construction_worker: Installation
**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) first, then in order to clone the project via HTTPS, run this command:**
```git clone https://github.com/LauraBeatris/gofinances-api.git```
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:
```git clone [email protected]:LauraBeatris/gofinances-api.git```
**Install dependencies**
```yarn install```
Create your enviroment variables based on the examples of ```.env.example```
```cp .env.example .env```
After copying the examples, make sure to fill the variables with new values.
**Setup a database**
Install [Postgres](https://www.postgresql.org/) to create a database or if you have [Docker](https://www.docker.com/) in your machine, fill the environment values related to database configurations and then run the following commands in order to create a postgres container.
```docker-compose up```
# :runner: Getting Started
Run the transactions in order to configure the database schema
```yarn typeorm migration:run```
Run the following command in order to start the application in a development environment:
```yarn dev:server```
# :postbox: Faq
**Question:** What are the tecnologies used in this project?
**Answer:** The tecnologies used in this project are [NodeJS](https://nodejs.org/en/) + [Express Framework](http://expressjs.com/en/) to handle the server and [TypeORM](https://typeorm.io/#/)
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the the [GoFinances API](https://github.com/LauraBeatris/gofinances-api/issues) repository. If you already found a solution to your problem, **i would love to review your pull request**! Have a look at our [contribution guidelines](https://github.com/LauraBeatris/gofinances-api/blob/master/CONTRIBUTING.md) to find out about the coding standards.
# :tada: Contributing
Check out the [contributing](https://github.com/LauraBeatris/gofinances-api/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
Released in 2020.
This project is under the [MIT license](https://github.com/LauraBeatris/gofinances-api/master/LICENSE).
Made with love by [Laura Beatris](https://github.com/LauraBeatris) 💜🚀