Chiru-Stack / ToDo

The To-Do List App is an application built on Node.js, Express, MongoDB, and the EJS templating engine, with the aim of assisting users in effectively organizing their tasks.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

To-Do List App

The To-Do List App is an application built on Node.js, Express, MongoDB, and the EJS templating engine, with the aim of assisting users in effectively organizing their tasks.

Prerequisites

Before running this project, make sure you have the following installed:

Installation

Follow these steps to set up the application:

  1. Open Powershell/Terminal and Clone the repository to your local machine:

    git clone https://github.com/Chiru-Stack/ToDo.git
  2. Navigate to the project directory:

    cd ToDo
  3. Install the required dependencies:

    npm install
  4. Install additional packages:

    npm install mongoose lodash

Get Started

To run the To-Do List App, perform the following actions:

  1. Open a new PowerShell window.

  2. Start the MongoDB:

    mongod
  3. Open another PowerShell window.

  4. Launch the MongoDB shell:

    mongosh
  5. Open another PowerShell window and Navigate to the project directory:

    cd ToDo
  6. Start the application using nodemon:

    nodemon .\app.js
  7. Open a web browser and navigate to localhost:3000 to access the application. Use localhost:3000/work and whatever you want to create new todo list.

Usage

  • Home Page (http://localhost:3000): This is the default page that shows the "Today" list. You can add new items to the list by typing in the input field and clicking the "+" button.

  • Custom Lists: You can create custom lists by adding a name in the URL (e.g., http://localhost:3000/work). You can then add items to the custom list and access it using the specified name.

  • Deleting Items: To delete an item, click on the checkbox next to the item. It will be marked as completed and automatically removed from the list.

  • About Page (http://localhost:3000/about): This page provides information about the To-Do List application.

Project Structure

The project structure is as follows:

  • app.js: The main entry point of the application. It configures the server, sets up the routes, and connects to the database.

    Models: "app.js" contains the Mongoose models for the database schema.

    • Item: The model for individual to-do list items.
    • List: The model for the custom lists.
  • public: This directory contains static files such as CSS stylesheets.

    • styles.css: This file contains the CSS stylesheets for the application.
  • views: This directory contains the EJS templates used to render the HTML pages.

    • header.ejs: The header template that is included in other EJS files.

    • footer.ejs: The footer template that is included in other EJS files.

    • list.ejs: The template for the to-do list page.

    • about.ejs: The template for the about page.



Acknowledgements

This project was developed utilizing Node.js, Express, MongoDB, and the EJS templating engine.

We extend our sincere appreciation to the creators and contributors of these technologies for their significant contributions.

Furthermore, I wish to convey my thanks to my instructor, Angela Yu, for her invaluable guidance and unwavering support throughout the project's development.



Contact Details


About

The To-Do List App is an application built on Node.js, Express, MongoDB, and the EJS templating engine, with the aim of assisting users in effectively organizing their tasks.

License:GNU General Public License v3.0


Languages

Language:JavaScript 58.7%Language:CSS 22.8%Language:EJS 18.5%