{"id":16979497,"url":"https://github.com/smallpaes/todo-list","last_synced_at":"2025-03-22T15:30:36.969Z","repository":{"id":35400649,"uuid":"198034482","full_name":"smallpaes/todo-list","owner":"smallpaes","description":"A practical web application built with Node.js, Express, and MySQL for you to readily record, view, and manage your tasks with an account: Create, view, edit, delete, filter, and sort expenses are as easy as pie 🥧","archived":false,"fork":false,"pushed_at":"2022-12-10T23:08:32.000Z","size":11243,"stargazers_count":22,"open_issues_count":13,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-01T16:47:46.350Z","etag":null,"topics":["animatecss","authentication","crud","csurf","express-validator","expressjs","facebook","facebook-authentication","mysql","nodejs","passportjs","sequelize","todo","todolist"],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smallpaes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-21T08:55:11.000Z","updated_at":"2024-12-11T08:32:08.000Z","dependencies_parsed_at":"2023-01-15T20:15:39.738Z","dependency_job_id":null,"html_url":"https://github.com/smallpaes/todo-list","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallpaes%2Ftodo-list","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallpaes%2Ftodo-list/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallpaes%2Ftodo-list/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smallpaes%2Ftodo-list/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smallpaes","download_url":"https://codeload.github.com/smallpaes/todo-list/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244217929,"owners_count":20417677,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animatecss","authentication","crud","csurf","express-validator","expressjs","facebook","facebook-authentication","mysql","nodejs","passportjs","sequelize","todo","todolist"],"created_at":"2024-10-14T01:45:58.680Z","updated_at":"2025-03-22T15:30:31.948Z","avatar_url":"https://github.com/smallpaes.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Todo List 📆\nA practical web application built with Node.js, Express, and MySQL for you to readily record, view, and manage your tasks with an account: Create, view, edit, delete, filter, and sort todos are as easy as pie 🥧\n\n\n### Trial in this project 🤠\n**To increase user experience**\n+ [Animate.css](https://daneden.github.io/animate.css/) is used to show animation for certain actions\n\n\n**To enhance security**\n+ [csurf](https://www.npmjs.com/package/csurf) is used to prevent CSRF Attacks \n+ [express-validator](https://www.npmjs.com/package/express-validator) is used for server side validation\n\n___\n\n## Project First Look\n![Application Screen Shot in GIF](todoList.gif)\n\n\n## Features\n| Functions              | Detail                                            | URL                         |\n| :--------------------: | ------------------------------------------------- | --------------------------- |\n| Sign up for an account | 1. User can sign up an account by inputting name, email, password\u003cbr\u003e2. User can get a warning message for invalid input format | /users/register |\n| Log in with email | 1. User can log in using registered email\u003cbr\u003e2. User can get a warning message for incorrect password or unregistered account | /users/login |\n| Log in with Facebook account | User can log in via Facebook with a Facebook account | /auth/facebook |\n| Log out | 1. User can log out of an account\u003cbr\u003e2. User can get a reminder for successful logout | /users/logout |\n| View all todos | 1. User can view todos list with name, due date and status after login\u003cbr\u003e2. User can get an error message when no todo to display after login | / |\n| View a todo | User can view name, due date, status, and detail of a todo after login | /todos/view/:id |\n| Create a todo | 1. User can add a todo with detail after login\u003cbr\u003e2. User can get a warning message for invalid input format | /todos/new |   \n| Edit a todo | User can update detail info of a todo after login | /todos/edit/:id |\n| Delete a todo | 1. User can delete a todo after login\u003cbr\u003e2. User can receive a warning message before actual delete | /todos/delete/:id |\n| Filter todos | User can filter todos based on status and due date | /search |\n| Sort todos | User can sort todos based on status, due date, or name | /search |\n| Page not found | User can get an error message when travelling to a page not existing | /:any_other_URL |\n\n___\n\n## Installation\nThe following instructions will get you a copy of the project and all the setting needed to run it on your local machine.\n\n\n### Prerequisites\n\n- [npm](https://www.npmjs.com/get-npm)\n- [Node.js v10.16.0](https://nodejs.org/en/download/)\n- [MySQL v8.0.16](https://dev.mysql.com/downloads/mysql/)\n- [MySQL Workbench v8.0.16](https://dev.mysql.com/downloads/workbench/)\n\n\n### Clone\n\nClone this repository to your local machine\n\n```\n$ git clone https://github.com/smallpaes/todo-list.git\n```\n\n### Setup Datebase\n\n**Create and use todo-sequelize database via MySQL Workbench**\n\n\u003e Run the following code\n```\ndrop database if exists todo_sequelize;\ncreate database todo_sequelize;\nuse todo_sequelize;\n```\n\n### Setup App\n\n**1. Create a Facebook account**\n- [https://developers.facebook.com/](https://developers.facebook.com/)\n\n**2. Create a Facebook App and get the App ID \u0026 Secret**\n\n```\nMy Apps -\u003e Create App -\u003e Scenario: Integrate Facebook Login -\u003e Settings -\u003e Basic\n```\n\n**3. Enter the project folder**\n\n```\n$ cd todo-list\n```\n\n**4. Install packages via npm**\n\n```\n$ npm install\n```\n\n**5. Create .env file**\n\n```\n$ touch .env\n```\n\n**6. Store API Key in .env file and save**\n\n```\nFACEBOOK_ID=\u003cYOUR_FACEBOOK_APP_ID\u003e\nFACEBOOK_SECRET=\u003cYOUR_FACEBOOK_APP_SECRET\u003e\nFACEBOOK_CALLBACK=\u003cYOUR_FACEBOOK_REDIRECT_URI\u003e\n```\n\n**7. Edit password in config.json file**\n\n\u003e /config/config.json\n```\n\"development\": {\n  \"username\": \"root\",\n  \"password\": \"\u003cYOUR_WORKBENCH_PASSWORD\u003e\",\n  \"database\": \"todo_sequelize\",\n  \"host\": \"127.0.0.1\",\n  \"dialect\": \"mysql\",\n  \"operatorsAliases\": false\n}\n\n```\n\n**8. Create models**\n\n\u003e run the following code in the console\n```\n$ npx sequelize db:migrate\n```\n\n**9. Activate the server**\n\n```\n$ npm run dev\n```\n\n**10. Find the message for successful activation**\n\n```\n\u003e App is running on port 3000!\n```\nYou may visit the application on browser with the URL: http://localhost:3000\n\n___\n\n\n## Authors\n[Mike Huang](https://github.com/smallpaes)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmallpaes%2Ftodo-list","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmallpaes%2Ftodo-list","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmallpaes%2Ftodo-list/lists"}