molefrog / ftt

💸 An expense tracking application based on 50-30-20 budgeting rule. A hackathon project.

Fifty Thirty Twenty

An expense tracking application based on a 50-30-20 rule. This budgeting rule helps people to wisely manage their expenses and savings. Here is what it is based on:

1. 50% you spend on "needs": life-related things like helthcare, rent, food etc.
2. 30% you spend on "wants": restaurants, leisure etc.
3. 20% you save.

Designs assets location

You can find Sketch design sources inside /design folder. This file contains general application style guide as well as designs of all application screens.

Deploying the code

The code can be deployed using just one command now.

Starting the project up

npm start or yarn start runs the app in development mode. Open http://localhost:3000 to view it in the browser.

npm run build or yarn build Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The basic API structure

Header Authourization: Token token=aabbccee

POST /api/session ~> { "token": "aabbccee" }
DELETE /api/session - destroys user session (removes from the fake db).
GET  /api/cards ~> { "cards": [] } list of user's cards
POST /api/cards/:id/setup sets the card as active and returns the payload
GET  /api/transactions - returns the payload
POST /api/sync - fetches and syncs new transactions
PUT  /api/expenses/:id/tag

payload: {
  card_id: "aabbcc",
  balance: null,
  expenses: [],
  incomes: []
}

License

MIT License

Copyright (c) 2017 Sergey Avdyakov and Alexey Taktarov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.