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

https://github.com/forloop94/book-store


https://github.com/forloop94/book-store

Last synced: 9 months ago
JSON representation

Awesome Lists containing this project

README

          


Book Store


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 About ](#-about-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 About

**Book Store** is a website for storing books. The users will be able to display a list of books, add and delete books as they like. This UI will be built using React and I intend to learn how to use React and Redux in the context of a real application.

## 🛠 Built With

### Tech Stack

- HTML
- CSS
- Javascript
- React
- Redux

### Key Features

- [ ] **Display books**
- [ ] **Add books**
- [ ] **Delete books**

(back to top)

## 🚀 Live Demo

[Live-demo](https://book-store-3kqg.onrender.com)

(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:

- a browser
- git
- nodejs

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone git@github.com:forLoop94/book-store.git
npm install
```

### Usage

To run the project, execute the following command:

```sh
Open index.html in browser
or
open with Live server in Vscode
```

### Run tests

To run tests, run the following commands:

```sh
npx stylelint "**/*.{css,scss}"
npx npx eslint "**/*.{js,jsx}"
npm test
```

(back to top)

## 👥 Author

👤 **Charles Andrews**

- GitHub: [@githubhandle](https://github.com/forLoop94)
- Twitter: [@twitterhandle](https://twitter.com/_AndrewsCharles)
- LinkedIn: [LinkedIn](https://linkedin.com/in/andrewscharles94)

(back to top)

## 🔭 Future Features

- [ ] **Using Redux**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Mahamadou-Nouridine/My-Portfolio/issues).

(back to top)

## ⭐️ Show your support

If you like this project give me a follow and/or a star

(back to top)

## 🙏 Acknowledgments

My coding partners

(back to top)

## 📝 License

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

(back to top)