GoFinances is an web application made to control the user's income and outcome financial transactions. The user is able to create new transactions from the application as well as importing then from CSV files. The application uses an authentication system with JWT tokens to keep data restricted to each user.
Both backend and frontend where made using Typescript language. The backend is a REST API, programmed with SOLID principles in mind and taking advantage of unit tests for each use case of the application, connected to a postgres database. The frontend is an web application made with React following the "mobile first" principle, being responsive to any device resolution.
GoFinances is part of the GoStack Bootcamp Challanges by Rocketseat.
- React
- React Router
- React Hook Form
- Styled Components
- Axios
- Polished
- React Toastify
- React Drop Zone
- React Icons
Clone the repository to your machine:
git clone https://github.com/marmitoTH/gofinances.git
The backend will expect you to have a postgres database running on your machine, you can change the database credentials in ormconfig.json file.
yarn install # Install all dependencies
yarn typeorm migration:run # Create the necessary tables
yarn start # Start the server
yarn test # Run test suites
The server will be listening the port 3333.
yarn install # Install all dependencies
yarn start # Start the application
POST /users
{
"name": "Your Name",
"email": "your_email@mail.com",
"password": "your_password"
}
POST /sessions
{
"email": "your_email@mail.com",
"password": "your_password"
}
GET /transactions
GET /transactions/take/1/skip/0 # Pagination
POST /transactions
{
"title": "New Transaction",
"value": 12000,
"type": "income" | "outcome",
"category": "New or existing category"
}
POST /transactions/import # CSV file must be sent via multipart form
DELETE /transactions/:id