todo-list

Project description

This project is an implementation of a todo-list web page.

This project was done mainly for learning purposes, the aim was to practice using javascript factories/classes/constructors. The project's specifications are listed on The odin project

Screenshot

Built with

• HTML5
• CSS3
• Vanilla Javascript
• Webpack js framework
• Javascript design patterns

Features

• This has a home page, where users can access the app's features
• User can
  • create a todo
  • edit a todo
  • create new projects
  • view all projects
  • view all todos in each project
  • remove a todo from a project
  • delete a todo

Deployed Site

ToDo List app on heroku

Running and testing it locally

Prerequisites

• NodeJS
• Yarn or just the default npm which comes with NodeJS

Setup

• Run git clone https://github.com/descholar-ceo/todo-list && cd todo-list to get a copy of source codes on your local computer and to navigate inside the project directory
• Run yarn install
• Run yarn build

Usage

• Run yarn dev to run this app in development environment or yarn start to run this project in production environment

Tests

• No test yet

Contributions

There are two ways of contributing to this project:

1. If you see something wrong or not working, please check the issue tracker section, if that problem you met is not in already opened issues then open a new issue by clicking on new issue button.

2. If you have a solution to that, and you are willing to work on it, follow the below steps to contribute:

   1. Fork this repository
   2. Clone it on your local computer by running git clone https://github.com/your-username/todo-list.git Replace your username with the username you use on github
   3. Open the cloned repository which appears as a folder on your local computer with your favorite code editor
   4. Create a separate branch off the master branch,
   5. Write your codes which fix the issue you found
   6. Commit and push the branch you created
   7. Raise a pull request, comparing your new created branch with our original master branch here

Author

👤 Mugirase Emmanuel

• Github: @descholar-ceo
• Twitter: @descholar3
• Linkedin: MUGIRASE Emmanuel

👤 Marylene Sawyer

• Github: @Bluette1
• Twitter: @MaryleneSawyer
• Linkedin: Marylene Sawyer

Show your support

Give a ⭐️ if you like this project!

Acknowledgment

• Microverse

• Webpack