Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 3.04 KB

README.md

File metadata and controls

82 lines (52 loc) · 3.04 KB
Raw

Budget Notebook

  • Budget Notebook is a personal financial planning application.

  • Users can set up budgets and saving goal by month, browse budget status and saving goal achievement. Users can edit and delete budgets.

  • Users can browse, record, edit, delete transactions.

  • Users can browse balance amount by month and year.

Screenshots

  • Dashboard Page "screenshot of the dashboard"

  • Budget Page "screenshot of the budget page"

"screenshot of the budget page"

"screenshot of the budget page"

  • Transaction Page "screenshot of the transaction page"

"screenshot of the transaction page"

Dependencies

Front-end

  • React
  • React-dom
  • React-router
  • React-router-dom
  • React-scripts
  • Recharts
  • Axios
  • Chakra UI
  • Material UI
  • Recharts
  • Emotion/react
  • Emotion/styled
  • framer-motion

Back-end

  • Node JS
  • Express
  • PostgreSQL
  • pg-native
  • dotenv
  • nodemon
  • chalk

Set up

  1. Clone this repository.

  2. You need two terminal windows/tabs to run the back-end server and front-end app. In one terminal, cd into express-back-end, in the other terminal, cd into react-front-end.

  3. In express-back-end directory, install dependencies using the command npm install.

  4. In express-back-end directory, create a local database by PostgreSQL using the following commands (replace your_username and your_password in the commands with your choice): psql -U postgres, CREATE ROLE your_username WITH LOGIN password 'your_password';, CREATE DATABASE budget_notebook OWNER your_username;.

  5. In express-back-end directory, create .env file based on .env.example. Update the .env file with your local database information set in the last step.

  6. In express-back-end directory, Run npm run db:reset to reset the database.

  7. In react-front-end directory, install dependencies using the command npm install.

  8. In both terminal, run npm start and go to localhost:3000 in your browser.

  9. Log in using the email: test@test.com and password: 123. Enjoy!

Collaboration:

  • Feng Liu: Front-end and back-end functions of budget route, dashboard route and user route. Search Function, parts of edit and add function of transaction route.

  • Dylan McGrann: Front-end and back-end functions of transaction route.

  • Suki Chan: Charts,UI and data seeds.