Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 4.14 KB

README.md

File metadata and controls

105 lines (81 loc) · 4.14 KB
Logo Agenda

A minimalist web app to manage your finances 🤑

TypeScript badge React badge Next.js badge

🚀 Technologies   |    📃 Project   |    💻 How to execute   |    📝 License

Budget

🚀 Technologies

This project was developed using the following technologies:

📃 Project

This is project is a frontend of a finance app to calculate your incomes and outcomes along the month. It has no backend implemented, Mirage JS is being used to simulate GET and POST API methods in order to let ready all the frontend functionalities even without a real backend.

💻 How to execute

Requirements

To follow the process bellow you'll need Git and Node.js installed to follow the tutorial.

In case you haven't Git installed, you can just download the repository through browser and execute the last two steps (below) inside the app folder.

Setting up the application

# Clone the repository
$ git clone https://github.com/aronreisx/budget.git
# Access the project folder through the terminal
$ cd budget
# Install all the packages
$ npm i
# Start the application
$ npm start

Accessing the application

The server will start at port 3000 - now you're abble to access the application at http://localhost:3000.

📝 License

This repository are under MIT LICENSE. For detailed informations, read the file LICENSE.


Final Considerations

If you find any issue, please go to Issue section and open a new issue describing what happened.

If you have anything to contribute with this project, you're free to make a Pull resquest. I'll be very Happy!


Made by Aron Reis