Skip to content

Commit

Permalink
Update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
RaphDasilva committed Jan 17, 2023
1 parent 0ce71eb commit 6904606
Showing 1 changed file with 246 additions and 1 deletion.
247 changes: 246 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,246 @@
# To-do-list
# To-do-list
<a name="readme-top"></a>

<!-- TABLE OF CONTENTS -->

# 📗 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](#faq) -->
- [📝 License](#license)

<!-- PROJECT DESCRIPTION -->

# 📖 [Awesome-Books] <a name="about-project"></a>

> Describe your project in 1 or 2 sentences.
**[Awesome-Books]** Is a 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. You will build a simple website that allows for doing that, and you will do it using ES6 and Webpack!.

## 🛠 Built With <a name="built-with"></a>

- HTML
- CSS
- JavaScript
- Webpacks

<!-- ### Tech Stack <a name="tech-stack"></a>
<!-- ### Tech Stack <a name="tech-stack"></a> -->

<!-- > Describe the tech stack and include only the relevant sections that apply to your project. -->
<!--
<details>
<summary>Client</summary>
<ul>
<li><a href="https://reactjs.org/">React.js</a></li>
</ul>
</details>
<details>
<summary>Server</summary>
<ul>
<li><a href="https://expressjs.com/">Express.js</a></li>
</ul>
</details>
<details>
<summary>Database</summary>
<ul>
<li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
</ul>
</details>
-->

<!-- Features -->

### Key Features <a name="key-features"></a>

> Describe between 1-3 key features of the application.
- **[Responsive]**
- **[Dynamic-Pages]**
- **[Add and Remove to do list]**


<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- LIVE DEMO -->

## 🚀 Live Demo <a name="live-demo"></a>

> Add a link to your deployed project.
- [Live Demo Link](Coming soon)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->

## 💻 Getting Started <a name="getting-started"></a>

> Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- Web Browser
- Code Editor: [visual Studio code](https://code.visualstudio.com/)

### Setup

Clone this repository to your desired folder:

1. Go to the [repository page](https://github.com/RaphDasilva/Awesome-books).
2. Press the "Code" button and copy the link.
3. Clone it using git command `git clone <link>`.

### Install

Install this project with:

```
npm install
```

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!--
### Usage
To run the project, execute the following command:
<!--
Example command:
```sh
rails server
```
--->

<!-- ### Run tests
To run tests, run the following command: -->

<!--
Example command:
```sh
bin/rails test test/models/article_test.rb
```
--->

<!-- ### Deployment
You can deploy this project using: -->

<!--
Example:
```sh
```
-->

<!-- <p align="right">(<a href="#readme-top">back to top</a>)</p> -->

<!-- AUTHORS -->

## 👥 Authors <a name="authors"></a>

> Mention all of the collaborators of this project.
👤 **Raphael Okolo**

- GitHub: [@githubhandle](https://github.com/RaphDasilva)
- LinkedIn: [@LinkedIn](https://www.linkedin.com/in/raphael-okolo-480012227/)


<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- FUTURE FEATURES -->

<!-- ## 🔭 Future Features <a name="future-features"></a>
> Describe 1 - 3 features you will add to the project.
- [ ] **[new_feature_1]**
- [ ] **[new_feature_2]**
- [ ] **[new_feature_3]**
<p align="right">(<a href="#readme-top">back to top</a>)</p> -->

<!-- CONTRIBUTING -->

## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- SUPPORT -->

## ⭐️ Show your support <a name="support"></a>

> Write a message to encourage readers to support your project
If you like this project...

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ACKNOWLEDGEMENTS -->
<!--
## 🙏 Acknowledgments <a name="acknowledgements"></a> -->

<!-- > Give credit to everyone who inspired your codebase.
I would like to thank...
<p align="right">(<a href="#readme-top">back to top</a>)</p> -->

<!-- FAQ (optional) -->

<!-- ## ❓ FAQ <a name="faq"></a>
> Add at least 2 questions new developers would ask when they decide to use your project.
- **[Question_1]**
- [Answer_1]
- **[Question_2]**
- [Answer_2]
<p align="right">(<a href="#readme-top">back to top</a>)</p> -->

<!-- LICENSE -->

## 📝 License <a name="license"></a>

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 comments on commit 6904606

Please sign in to comment.