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

https://github.com/developerwaleed/react-bookstore


https://github.com/developerwaleed/react-bookstore

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          


logo


# 📗 Table of Contents

Click to view contents



  1. 📖 About the Project



  2. 💻 Getting Started


  3. 👥 Authors

  4. 🔭 Future Features

  5. 🤝 Contributing

  6. ⭐️ Show your support

  7. 🙏 Acknowledgements

  8. ❓ FAQ

  9. 📝 License

# 📖 React Book Store

**React Book Store** is a website that allows its users to add books and keep track of their reading. The website uses redux to fetch and send data to the API.

## 🛠 Built With

### Tech Stack

- React
- Redux

Client

### Key Features

This projects aim is to serve as the book tracking website!

- Consume Rest API
- Save data in redux store
- Render data from redux store

(back to top)

## 🚀 Live Demo
[Click Here for live Version!](https://react-book-store-dusky.vercel.app/)

(back to top)

## 💻 Getting Started

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

### Prerequisites

- Node Package Manager (npm)

### Setup

#### Github
- Enter this url: [https://github.com/developerwaleed/React-BookStore](https://github.com/developerwaleed/React-BookStore) in your web browser.
- Once opened navigate to the top left level of the project a green code download button will be visible on the righthand side.
- Select the download Zip option from drop-down menu.
- Once the download is complete you will be able to access my project locally.

#### Local (Terminal)

```sh
git clone https://github.com/developerwaleed/React-BookStore.git
cd React-BookStore
```

### Install

Install dependencies and gems in this project with:

```sh
cd React-BookStore
npm install
```

### Usage

To run the project, execute the following command:

- Run `npm run start` or `npm start` to start a development server.

### Run tests

To run tests, run the following command:

```
npm run test
```

### Deployment

You can deploy this project using:

- Github Pages
- Netlify

(back to top)

## 👥 Authors
| 👤 Name | Github | Twitter | LinkedIn |
|------|--------|---------|----------|
|Waleed Amjad|[@caasperr](https://github.com/developerwaleed)|[@developerwaleed](https://twitter.com/developerwaleed)|[@developerwaleed](https://www.linkedin.com/in/developerwaleed/)

(back to top)

## 🔭 Future Features

- Currently none.

(back to top)

## 🤝 Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue, feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project. Don't forget to give it a ⭐️

(back to top)

## 🙏 Acknowledgments

- A big thanks to [@microverseinc](https://github.com/microverseinc) for the project idea, guidance and inspiration.

(back to top)

## ❓ FAQ

- **What inspired me to create this project?**

- The inspiration for this project came from microverse – a software development bootcamp where you work with teammates remotely on different projects.

(back to top)

## 📝 License

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

(back to top)