Simple Node/Express API to manage a budget using a Envelop Budgeting Principles. Users can create, read, update, and delete envelopes. This API follows best practices regarding REST endpoint naming conventions and proper response codes. The project is a challange-project from the Back-End Developer course at Codecademy.
In order to run the program, you need to install Node.js on your computer.
Once installed, install the program's dependencies with npm install in your terminal with the
project's folder as working directory, then npm run start.
Once the app is running locally, you can access the API at http://localhost:5000/
Swagger documentation and testing available at http://localhost:5000/api-docs
To test with Swagger:
- Retrieve envelopes using
GET /api/v1/envelopes - Retrieve a single envelope using
GET /api/v1/envelopes/{id} - Create an envelope using
POST /api/v1/envelopes - Update an envelope using
PUT /api/v1/envelope/{id} - Delete an envelope using
DELETE /api/v1/envelope/{id} - Transfer money between envelopes using
POST /api/v1/envelope/{fromId}/transfer/{toId}