A practical web application built with Node.js, Express, and MongoDB for you to readily record, view, and manage your expense with an account: Create, view, edit, delete, filter expenses are as easy as pie 🥧
To increase user experience
- Nodemailer is used to send email
- Chart.js is used to visualize data in beautiful chart
To enhance security
- csurf is used to prevent CSRF Attacks
- express-validator is used for server side validation
- Utilizing token during password reset process
Async/Await
| Functions | Detail | URL |
|---|---|---|
| Sign up for an account | 1. User can sign up an account by inputting name, email, password 2. User can get a warning message for invalid input format 3. User can be redirected to login page and receive a warning message for registered account 4. User can receive an email for successful registration |
/users/register |
| Log in with email | 1. User can log in using registered email 2. User can get a warning message for incorrect password or unregistered account |
/users/login |
| Log in with Facebook account | User can log in via Facebook with a Facebook account | /auth/facebook |
| Reset password | 1. User can choose to reset password by providing email 2. User can receive an email with reset link 3. User can reset email by visiting reset link |
/users/reset |
| Log out | User can log out of an account | /users/logout |
| View all expenses | 1. User can view expense detail after login 2. User can get an error message when no expense to display after login |
/ |
| View total expense | 1. User can see total amount of all expense in number 2. User can see total amount of each category expense on bart chart |
/ |
| Create an expense | 1. User can add an expense with related info after login 2. User can get a warning message for invalid input format |
/expenses/new |
| Edit an expense | User can update detail info of an expense after login | /expenses/edit/:id |
| Delete an expense | 1. User can delete an expense after login 2. User can receive a warning message before actual delete |
/expenses/delete/:id |
| Filter expenses | 1. User can filter expenses based on month and category after login | /search |
| Page not found | User can get an error message when travelling to a page not existing | /:any_other_URL |
The following instructions will get you a copy of the project and all the setting needed to run it on your local machine.
Clone this repository to your local machine
$ git clone https://github.com/smallpaes/expense-tracker.git
1. Create an SendGrid & Facebook account
2. Create and get a SendGrid API Key
Dashboard -> Settings -> API Keys -> Create API Key
3. Create an Facebook App and get the App ID & Secret
My Apps -> Create App -> Scenario: Integrate Facebook Login -> Settings -> Basic
4. Enter the project folder
$ cd expense-tracker
5. Install npm packages
$ npm install
6. Create .env file
$ touch .env
7. Store API Key in .env file and save
SENDGRID_KEY=<YOUR_SENDGRID_API_KEY>
FACEBOOK_ID=<YOUR_FACEBOOK_APP_ID>
FACEBOOK_SECRET=<YOUR_FACEBOOK_APP_SECRET>
FACEBOOK_CALLBACK=<YOUR_FACEBOOK_REDIRECT_URI>
8. Import user and expense seeds
$ npm run seeder
9. Find the message for successful import
> db connected!
> User and record seeds are created
10. Activate the server
$ npm run dev
11. Find the message for successful activation
> Express is listening on http://localhost:3000
> mongodb connected!
You may visit the application on browser with the URL: http://localhost:3000
-
Why didn't I receive an email upon successful registration or password rest?
- They might been marked as spam, kindly check the spam folder in your mailbox.
-
Can I try this app online?
- Yes, kindly visit https://boiling-beach-19178.herokuapp.com/
-
Can I use Facebook to login online?
- No, the App is currently in development mode. However, you can test the function by following the setup instructions.