taejin5314 / LHL-midterm-project

Smart TODO List

Smart TODO List is an app that auto-categorizes any tasks you enter into one of 5 categories so that you don't have to!

Categories

1. Films
2. TV Series
3. Books
4. Restaurants and Cafes
5. Shopping and Other

_{^{** Note: As of first release, only these 5 categories are supported. **}}

Final Product

Login Page

Registration Page

All Tasks Page

All Tasks - Category Page

Individual Category Pages

Add Task

Edit Task

Edit Category

Complete Task

Delete Task

Complete List

Getting Started

1. Create the .env by using .env.example as a reference: cp .env.example .env

• Important - Please acquire API Keys for the following APIs and enter in your .env file with the following names:
  • OMDB_API_KEY - OMDB
  • YELP_API_KEY - Yelp Fusion
  • GOOGLE_API_KEY - Google Books API
  • SERP_API_KEY - Google Search API - SERP API

2. Update the .env file with your correct local information

• username: labber
• password: labber
• database: midterm

3. Install dependencies: npm i
4. Fix to binaries for sass: npm rebuild node-sass
5. Reset database: npm run db:reset

• Check the db folder to see what gets created and seeded in the SDB

7. Run the server: npm run local

• Note: nodemon is used, so you should not have to restart your server

8. Visit http://localhost:8080/

Warnings & Tips

• Do not edit the layout.css file directly, it is auto-generated by layout.scss
• Use the npm run db:reset command each time there is a change to the database schema or seeds.
  • It runs through each of the files, in order, and executes them against the database.
  • Note: you will lose all newly created (test) data each time this is run, since the schema files will tend to DROP the tables and recreate them.

Dependencies

• Node 10.x or above
• NPM 5.x or above
• PG 6.x
• Express
• Node-sass-middleware
• EJS
• Morgan
• Chalk
• bcrypt
• body-parser
• cookie-session
• pg
• pg-native
• superagent
• yelp-fusion
• omdb-client
• google-books-search