Expense Tracker

An app for recording sorts of expenses in daily live.

Table of Contents

1. About The Project
   • Main Function
   • Additional Modifications
   • Built With
2. Getting Started
3. Extra resources

About The Project

Main Function

• User login and register.
• CRUD operations for the user's expense records.
• View the records based on kinds of category.

Additional features

• Use virtual scroll for large number of records.
• Sort the records by name, date, category or expense amount.
• Filter the records by keyword and specific period.
• Use charts to present user's expense statistics (daily and overview).
• Status prompt popup (auto closing).

Built With

• 
• 

(back to top)

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/CYW-Allen/expense-tracker.git

2. Install NPM packages

   npm install

3. Check .env.example file to set the app required env vars in .env file
4. Initiate mysql service
5. Initialize the database

   npm run initdb

6. Insert some seed data

   npm run seed

After above steps, now you can run the app by the following command.

npm start

(back to top)