Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/adeola003/awesome_books_e6

This is project to replicate an online library with features to add and remove books. In this projects ES6 functionalities have been used
https://github.com/adeola003/awesome_books_e6

List: awesome_books_e6

css es6 html javascript

Last synced: 3 months ago
JSON representation

This is project to replicate an online library with features to add and remove books. In this projects ES6 functionalities have been used

Awesome Lists containing this project

README

        

Awesome books with class

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

# 📖 [Awesome_books]

**[Awesome_books]** This project is basic website that allows users to add/remove books from a list you can write the author and the title of the book to add them in array and it will display at the page.

## 🛠 Built With

### Tech Stack

Client

### Key Features

- [x] Create a collection that keeps a list of book
- [x] Create a function to add a new book to the collection, with title and author.
- [x] Create a function to remove a book from the collection.💯
- [x] Display all books saved in the collection in the top part of the page.
- [x] when a user clicks the "Add" button [A new book is added to the collection.] (The new book is displayed in the page)
- [x] the data is preserved in the browser's memory by using localStorage.

(back to top)

(back to top)

## 💻 Getting Started

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


### Prerequisites

In order to run this project you need:
Open terminal on the same folder of the project and run:
```sh
npm install
```

### Setup

Clone this repository to your desired folder:
```sh
git clone https://github.com/adeola003/Awesome_books_E6.git
cd Awesome_books
```
### Install

Install this project with:
```sh
npm install
```

### Usage

```
1. download the project from clone
2. open live server for the project
3. You can see it in the browser
```

### Run tests

- ### Linter Tests

To run tests, run the following command:

To check for html errors run:
```sh
npx hint .
```
To check for css errors run:
```sh
npx stylelint "**/*.{css,scss}"
```
To check for js errors run:
```sh
npx eslint .
```

(back to top)

## 👥 Authors

👤 **Abdel-Khafid SALAOU**

- GitHub: [@githubhandle](https://github.com/adeola003)
- Twitter: [@twitterhandle](https://twitter.com/khadaf6)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/abdel-khafid-salaou-a18396161)

(back to top)

## 🔭 Future Features

- [x] Add test to the project using jest
- [x] Add the live demo for the project
- [x] Add new some features to the project

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ⭐️ Show your support

If you like this feel free to follow me on github and give this project a star..

(back to top)

## 🙏 Acknowledgments

Thanks to the code reviewers hat are helping us to improve and to all the microverse team.

(back to top)

(back to top)

## 📝 License

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

(back to top)