Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stephenkati/to-do-list-review

To Do List is a website for listing different 'to do' activities. The website is build with HTML, CSS and Javascript.
https://github.com/stephenkati/to-do-list-review

Last synced: 23 days ago
JSON representation

To Do List is a website for listing different 'to do' activities. The website is build with HTML, CSS and Javascript.

Awesome Lists containing this project

README

        





To Do List

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [Video-presentation](#presentation)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 [To Do List]

**[To Do List]** is a website for listing different 'to do' activities.
The website is build with HTML, CSS and Javascript.

## 🛠 Built With

### Tech Stack

Client

Server

Database

### Key Features

> Describe between 1-3 key features of the application.

- **[Used Linters]**
- **[Great summary for the repo]**
- **[Use of Github Flow]**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](Not deployed yet)

(back to top)

## 💻 Getting Started

A new developer can get the project from my Github repo link i shall provide.

To get a local copy up and running, follow these steps.

go to https://github.com/stephenkati/To-Do-List-Review.git

clone or download the project

Run it in your favourite browser

### Prerequisites

In order to run this project you need:

-A code editor, preferably VSCode. Any other code editor is okay.

-Browser

### Setup

Clone this repository to your desired folder:

run git clone https://github.com/stephenkati/To-Do-List-Review.git

or

In the File menu, click Clone Repository.

Click the tab that corresponds to the location of the repository you want to clone. You can also click URL to manually enter the repository location.

Choose the repository you want to clone from the list.

Click Choose... and navigate to a local path where you want to clone the repository.

Click Clone.

### Install

Install this project with:

Download the project from github and run it in your browser.

### Usage

To run the project, navigate to the project directory and use a live Server extension in your VSCode to run the project.

### Run tests

You can run tests to check for linter errors by running the following commands:

- npx stylelint "**/*.{css,scss}" for testing css errors
- npx eslint . for Javascript errors

### Deployment

The project is not yet deployed.

(back to top)

## 👥 Author

👤 **Stephen Katuli**

- GitHub: [@githubhandle](https://github.com/stephenkati)
- Twitter: [@twitterhandle](https://twitter.com/Stephen57913145)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-katuli/)

(back to top)

## 🔭 Future Features

- [ ] **[More backround images]**
- [ ] **[Animations and transitions]**
- [ ] **[More Javascript Functionality]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/stephenkati/To-Do-List-Review/issues).

(back to top)

## ⭐️ Show your support

If you like this project please reach out to me on my social media, hire me for more content like this.

(back to top)

## 🙏 Acknowledgments

I would like to thankmy Microverse team and my coding partners for their support and guidance.

I would like to thank Kelly Sikkema for allowing me to use this amazing background image Kelly Sikkema on

(back to top)

## PRESENTATION

**PROJECT PRESENTATION VIDEO**

No presentation done yet.

## ❓ FAQ (OPTIONAL)

- **[How good are your communication skills?]**

- [I have good writting and speaking communication skills in English.]

- **[What else do you do apart from coding?]**

- [I do graphics design.]

(back to top)

## 📝 License

This project is MIT licensed.

(back to top)