About the projectย ย ย |ย ย ย Technologiesย ย ย |ย ย ย Getting startedย ย ย |ย ย ย How to contributeย ย ย |ย ย ย License
GoFinances is the application for who want to control your finances. With the feature to import a CSV (Comma-separated values) file you can bulk insert a lot of transactions.
Technologies that I used to develop this api
- Node.js
- ReactJS
- React Native
- TypeScript
- TypeORM
- Express
- PostgreSQL
- Jest
- SuperTest
- React Router DOM
- React Navigation
- React Icons
- Styled Components
- Axios
- Eslint
- Prettier
- EditorConfig
- Node.js
- Yarn
- One instance of PostgreSQL
Obs.: I recommend use docker
Clone the project and access the folder
$ git clone https://github.com/EliasGcf/gofinances.git && cd gofinances
Install dependencies
$ yarn
Follow the steps below
# Create the instance of postgreSQL using docker
$ docker run --name gofinances-postgres -e POSTGRES_USER=docker -e POSTGRES_PASSWORD=docker -e POSTGRES_DB=gofinances -p 5432:5432 -d postgres
# Make sure the keys in 'packages/server/ormconfig.json'
# to connect with your database are set up correctly.
# Once the services are running, run the migrations
$ yarn server typeorm migration:run
# To finish, run the api service
$ yarn server dev:server
# Well done, project is started!
Obs.: Before to continue, be sure to have the API running
# Be sure the file 'packages/web/src/services/api.ts' have the IP to your API
# Start the client
$ yarn web start
Make a fork of this repository
# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.
$ gh repo fork EliasGcf/gofinances
Follow the steps below
# Clone your fork
$ git clone your-fork-url && cd gofinances
# Create a branch with your feature
$ git checkout -b my-feature
# Make the commit with your changes
$ git commit -m 'feat: My new feature'
# Send the code to your remote branch
$ git push origin my-feature
After your pull request is merged, you can delete your branch
This project is licensed under the MIT License - see the LICENSE file for details.
Made with ๐ ย by Elias Gabriel ๐ ย See my linkedin