https://github.com/ashmalzahra/react-to-do-list

A react "To-Do list" tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete. Built with React.
https://github.com/ashmalzahra/react-to-do-list

css react react-router single-page-app

Last synced: 23 days ago
JSON representation

A react "To-Do list" tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete. Built with React.

• Host: GitHub
• URL: https://github.com/ashmalzahra/react-to-do-list
• Owner: ashmalzahra
• License: mit
• Created: 2023-02-20T17:13:24.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-04-13T22:31:53.000Z (over 1 year ago)
• Last Synced: 2024-12-06T03:44:48.949Z (about 1 month ago)
• Topics: css, react, react-router, single-page-app
• Language: JavaScript
• Homepage:
• Size: 612 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 📗 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)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 React-toDoList

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Built With

- React.js

- VSCode and GitHub

(back to top)

### Tech Stack 


  Client

  


    
React.js

  

  


    
Html

  

  


    
CSS

  


  Server

  


    
N/A

  


Database

  


    
N/A

  


### Key Features

- **[React Routers]**

- **[Git Flow]**

- **[Best practices for JavaScript]**

(back to top)


## Live Demo

[Live Demo Link](https://react-to-do-list.onrender.com/)

## 💻 Getting Started

Clone this repository to get started with the project, make sure to configure linters by following the instructions in the [Linters README file](https://github.com/microverseinc/linters-config/blob/master/README.md)

### Prerequisites

In order to run this project you need:

- A working computer.

- Connection to internet.

### Setup

- Clone the folder to your local machine.

- Open a local copy of the project in your code editor.

(back to top)


### Usage

- To run the project, execute the following command:

    - npm start in your terminal.

- To run test functions, execute the following command:

    - npm test in your terminal.

(back to top)


### Run tests

- After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.

  - For stylelint errors run:sudo npx stylelint "\*_/_.{css,scss}" --fix for automatic fix.

  - For ESLINT errors run:npx eslint "**/*.{js,jsx}" --fix for automatic fix.

(back to top)


## 👥 Authors

👤 **Ashmal Zahra**

- GitHub: [@ashmalzahra](https://github.com/ashmalzahra)

- Twitter: [@AshmalZahraae](https://twitter.com/AshmalZahraa)

- LinkedIn: [ashmal-zahra](https://www.linkedin.com/in/ashmal-zahra)

(back to top)


## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ashmalzahra/react-to-do-list/issues).

(back to top)


## ⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the information provided to build this project.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **Can I use the project for any purpose?**

  - Yes, you can.

- **Is the information saved in any database?**

  - No, it is not.

(back to top)


## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)