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

https://github.com/najibullahjafari/bookstore

Bookstore is a web application built with React and Redux that allows users to explore, categorize, and manage books. It features a user-friendly interface with options to add, edit, and remove books while tracking their reading progress
https://github.com/najibullahjafari/bookstore

axios bookstore front-end javascript material-ui prop-types react react-hooks react-redux react-router redux redux-toolkit state-management web-application web-development

Last synced: 4 months ago
JSON representation

Bookstore is a web application built with React and Redux that allows users to explore, categorize, and manage books. It features a user-friendly interface with options to add, edit, and remove books while tracking their reading progress

Awesome Lists containing this project

README

          




Book Store


# 📗 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](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Book Store

Book Store is a web app That we can remove, add and delete a book, I used React and JSX to build this web app.
Screenshot 2023-08-04 220430

## 🛠 Built With

- HTML,
- CSS,
- Java Script
- GIT,
- GITHUB
- LINTERS
- Webpack
- React

### Tech Stack

Client

Server

## 🚀 Live Demo

Check out the live demo of this project [here](https://64cd86e7739d9460c2d1d2c9--lucent-bavarois-61bf5d.netlify.app/).

### Key Features

- Linters for code quality
- Responsive design for different screen sizes
- In this project best coding practices is used.

## 💻 Getting Started

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

1. Go to this URL link: https://github.com/najibullahjafari/bookStore
2. clone the repo and start working on it.

### Prerequisites

In order to run this project you need:

Google Chrome or other browser

```sh
https://www.google.com/chrome/?brand=JJTC&gclid=CjwKCAjw9J2iBhBPEiwAErwpeSDcMFWiIQWj2u5GY6owZ7OaOHw7dYYCHW7uTR4kvYosNJYd4wt4VxoCiywQAvD_BwE&gclsrc=aw.ds
```

Github Account:

```sh
https://github.com/
```

Npm installed:

```sh
https://nodejs.org/en/download
```

Git installed:

```sh
https://git-scm.com/downloads/
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/najibullahjafari/bookstore
```

### Install

Please do the following **steps in this order**:

1. Use `npm run build` to instal all dependencies.
2. Then you can run project by `npm start` command

Linters:
If you had any issues with linters for `react` you can install as bellow:

### ESLint

1. Run
```
npm install --save-dev eslint@7.x eslint-config-airbnb@18.x eslint-plugin-import@2.x eslint-plugin-jsx-a11y@6.x eslint-plugin-react@7.x eslint-plugin-react-hooks@4.x @babel/eslint-parser@7.x @babel/core@7.x @babel/plugin-syntax-jsx@7.x @babel/preset-react@7.x @babel/preset-react@7.x
```
_not sure how to use npm? Read [this](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)._
2. Copy [.eslintrc.json](./.eslintrc.json) and [.babelrc](./.babelrc) to the root directory of your project.
3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**
4. Run `npx eslint "**/*.{js,jsx}"` on the root of your directory of your project.
5. Fix linter errors.
6. **IMPORTANT NOTE**: feel free to research [auto-correct options for Eslint](https://eslint.org/docs/latest/user-guide/command-line-interface#fixing-problems) if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!

### Stylelint

1. Run

```
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
```

_not sure how to use npm? Read [this](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)._

2. Copy [.stylelintrc.json](./.stylelintrc.json) to the root directory of your project.
3. **Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.**
4. Run `npx stylelint "**/*.{css,scss}"` on the root of your directory of your project.
5. Fix linter errors.
6. **IMPORTANT NOTE**: feel free to research [auto-correct options for Stylelint](https://stylelint.io/user-guide/usage/options) if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!

### Usage

To run the project, execute the following command:

Open the index.html in your browser

### Run tests

To run tests, run the following command:

to check for styling errors:

```sh
npx stylelint "**/*.{css,scss}"
```

### Deployment

You can deploy this project using:

Your working browser.

## 👥 Authors

👤 **Najibullah Jafari**

- GitHub: [Najibullah_jafari](https://github.com/najibullahjafari)
- Twitter: [Najibullah_jafari](https://twitter.com/Najib_Jafari_)
- LinkedIn: [Najibullah_jafari](https://www.linkedin.com/in/najibulla-jafari-609852263/)

(back to top)

## 🔭 Future Features

- **[Responsive Version]**

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/najibullahjafari/bookstore/issues).

(back to top)

## ⭐️ Show your support

Do you like this project? So don't wait to give one star!

(back to top)

## 🙏 Acknowledgments

I would like to express my deepest gratitude to Microverse for this project. The invaluable learning experience and support provided have been instrumental in my growth as a developer. My mentors and instructors deserve special thanks for their guidance and patience. The collaborative spirit of my fellow students has been a constant source of inspiration. I also extend my appreciation to the open-source community for their contributions. Lastly, my family and friends' unwavering support has been a driving force throughout this journey. Thank you, Microverse, for this incredible opportunity!

(back to top)

## 📝 License

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

(back to top)