A simple API made for easily storing financial data for a single user. Built for studying purposes.

• TypeScript
• Express
• SQLite

Clone or download the repository with:

git clone https://github.com/ramos-ph/budget-api.git
cd budget-api

After downloading, install the dependencies with your favorite package manager

npm install # or yarn

Run the migrations using the following script:

npm run migration:run # or yarn

This will create a budget.db SQLite database in the root of the project.

To run a local instance of the application, run:

npm run start:dev

The server will run on http://localhost:8080/. To check the available endpoints, refer to our API Reference.

For Mac and Linux, simply run:

npm test # or yarn

If you prefer, we watch mode to run the tests on the go:

npm run test:watch # or yarn

For Windows, it's recommended that you change package.json scripts to correctly set the environment.

Please refer to REFERENCE.md to see a list of all the available endpoints.

• Pedro Ramos - ramos-ph

This project is licensed under the MIT License - refer for LICENSE.md for details. Feel free to download, modify, ship or study this project as you wish.