n-caro / mybudget-frontend

A personal budget management 💸 web app built in React and Material UI and myBudget-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

myBudget-app

Overview

A personal budget management 💸 web app built in React and Material UI and myBudget-api

This is the frontend (client side) of the myBudget app. To see the backend API (server side) visit the repository: github.com/n-caro/mybudget-backend

1. About myBudget

Some features and dependencies:

  • 🎨 Material UI and Material UI icons.
  • Axios for API calls
  • Form validations with Formik
  • React router doom.

2. Features

  • User registration and authentication
  • Create operations of type Income or Expenses
  • Edit operations that have already been created
  • Delete operations
  • View account balance (current balance, total incomes, total expenses)
  • List of all operations, with pagination

2. Install and usage

Install

#clone the repository and go

$ git clone https://github.com/n-caro/mybudget-frontend.git
$ cd mybudget-frontend

#Install dependencies (yarn recommended)
$ yarn install

#or npm
$ npm install

After install dependencies, create a .env file (you can rename .env.example file) and set the URL for myBudget-api (github.com/n-caro/mybudget-backend)

.env (example):

REACT_APP_APIURL = http://localhost:4000/api

Usage

$ yarn start

#or npm
$ npm start

And go to http://localhost:3000

3. Screenshots

Sign up (and validations)

Sign up and validations

Sign in (and validations)

Sign in

Add operation

Add operations

Edit operation

Edit operation

Delete operation

Delete operation

Operations (and pagination)

Operations

Menu

Sign in

4. Upcoming Features

  • Operations: Filter by type
  • Operations: Select limit of results per page
  • Loading bar when API calls are made
  • Store and Actions for Operations (Redux or UseContext and useDispatch)
  • Animations for route change and data loading
  • Reports page (graphs) [Requires API update]

About

A personal budget management 💸 web app built in React and Material UI and myBudget-api


Languages

Language:JavaScript 96.4%Language:HTML 3.2%Language:CSS 0.3%Language:Shell 0.2%