/todo-list

Primary LanguageJavaScriptMIT LicenseMIT

Issues MIT License LinkedIn


Logo

Todo List

Todo list application with project organization.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

(back to top)

Built With

(back to top)

Getting Started

Instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

"dependencies": {
    "css-loader": "^6.7.1",
    "gh-pages": "^4.0.0",
    "html-loader": "^3.1.2",
    "html-webpack-plugin": "^5.5.0",
    "mini-css-extract-plugin": "^2.6.1",
    "node-sass": "^7.0.1",
    "path": "^0.12.7",
    "sass-loader": "^13.0.1",
    "style-loader": "^3.3.1",
    "webpack": "^5.73.0",
    "webpack-cli": "^4.10.0",
    "webpack-dev-server": "^4.9.2"
  }

Installation

  1. Clone the repo 
    git clone https://github.com/alexgeis/todo-list.git
  2. Install NPM packages 
    npm install
  3. DEVELOPMENT - run "npm start" to spin up the development server 
    npm start
  4. PRODUCTION - run "npm build" to bundle the page per the Webpack settings 
    npm run build

(back to top)

Usage

The user can add a new task or project by using the "+" icon in the header navigation.

add task/project icon help

These tasks/projects can be viewed in the following pages:

  • Dashboard: displays all tasks across all projects
  • All Projects: displays all projects created
  • Projects dropdown: displays your current projects and allows you to view tasks for each one

(back to top)

Roadmap

Higher Priority:

  • Improve card display/style
    • Completed status for tasks
    • clickable associated project display (related to first roadmap point)
  • ability to edit cards/projects by clicking on them (or an edit icon)
  • mobile responsiveness
  • All Projects page cards - allow user to go directly to that project by clicking on it
  • empty dashboard/projects/task display
    • show "no results" or similar text
    • show button to direct user to create a new project/task
  • Project association with task in Dashboard page
    • ability to delete task from dashboard and it deletes from the correct project (currently deletes from an array copy containing a consolidation of all tasks)

Lower Priority:

  • login/signup pages/functionality
  • settings page/functionality
  • Counters for total completed tasks and uncompleted tasks
  • Color theme toggle/choice

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

Please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Alex Geis - siegxela@gmail.com

Project Link: https://github.com/alexgeis/todo-list

(back to top)

Acknowledgments

Helpful resources and kudos.

(back to top)