TARI: Budget ahead, travel more

The main goal of this application is to help users to manage finances while traveling. Once created an account, they will be able to set budgets for future trips. They can also track their expenses by submitting and categorising transactions, while they check the status of their budgets. The web has been built with MERN full stack and it has been deployed with Heroku.

TABLE OF CONTENTS

• Demo
• Features
• Tech
  • Project Structure
  • API endpoints
• Getting Started
• User Interface

DEMO:

https://black-codher-hawa.herokuapp.com/

see more in the user interface section

FEATURES

1. Register and Login. The system validates the inputs. Some of the pages are only accessible for users who have registered and logged in.
2. Plan ahead of a trip and create a card to set budgets for a specific trip. Cards can be edited and deleted.
3. Submit transactions while traveling to track expenses specifying parameters such as category spent and date spent.
4. Check the status of budgets by viewing information such as amount spent, the amount left, and the number of transactions classified on a particular budget.
5. View a list of transactions. Filter and sort them too.

TECH

Technologies used: MongoDB, HTML, CSS, Reactjs, JavaScript, Nodejs, Redux

PROJECT STRUCTURE

This is the structure of the repository:

• client/src

  • assets : images used in the project
  • components : React components for the user interface
  • pages
  • Redux : related to state management
  • services
  • stylesheets : css files

• server

  • index.js : point of entry
  • routes : includes the API end points definition
  • models : Mongoose database Schemas
  • auth : related to registration and login system

API ENDPOINTS:

Transactions

• GET /api/expense/:ref - Get all the transactions for a specific user
• GET /api/expenses/:tripName/:ref - Get all the transactions of a trip for a specific user
• GET /api/balance/:trip/:ref -
• DELETE /api/expenses/transactions/:id - Delete a transaction
• POST /api/expense - Submit a transaction
• PUT /api/edit/transactions/:tripName/:user - Edit the name of the trip corresponding to a specific transaction for a specific user

Budgets

• GET /api/budget/:ref - Get all the infoCards of a user
• GET /api/budget/category/:tripName/:ref - Get all the information of a trip for a specific user
• POST /api/budget - Create a infoCard with budgets for a trip
• PUT /api/edit/card/:id - Edit budgets of a trip
• DELETE /api/delete/Info/card/:id - Delete infoCard storing budgets for a trip

Users

• POST /api/register - Register a user. Check that email has not been registrated yet, and both passwords coincide.
• POST /api/login - Login a user. Check that the user has registrated and inputs are correct.

GETTING STARTED

As the application stores all the data in a mongoDB database, it will be important that you have created a mongo clustard to run the project locally. You can choose to create an account here. Get more information reading the docs.

Once cloned you can start the application and run it locally, both (front-end) and (back-end) with the following commands:

1. Go to the root folder cd black-codher-my-personal-project

2. Create your environment variables. You will need to run the following commands:

export SECRET_KEY=<YOUR_SECRET_KEY>
export MONGO_URI=<YOUR_MONGODB_URI_TO_CONNECT_YOUR_APPLICATION>

3. Run the application.

   npm run start
   

   Your application will be running in localhost:3000

USER INTERFACE

View your budgets

Viewing your transaction