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

https://github.com/cancelei/bookstore

Main learning points: Used Create React App to build a Bookstore CMS. Done while doing Microverse Coding School.
https://github.com/cancelei/bookstore

Last synced: 3 months ago
JSON representation

Main learning points: Used Create React App to build a Bookstore CMS. Done while doing Microverse Coding School.

Awesome Lists containing this project

README

        


Bookstore

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

# 📖 React/Redux Bookstore
This is react redux project that includes a bookstore that stores the progress of an user's books. It uses redux to manage the state.

## 🛠 Built With Love and Passion

### Tech Stack

Client

### Key Features

- Updated Styling.
- Extra Book functionality > Select category before adding.
- Basic APP UI without styling.
- File Structure update.
- Implemented Redux Toolkit on the repo.
- Redux in Components

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

Download Project Files from github.

### Setup

Clone this repository to your desired folder:

### Install

Install Node Package by running:

- npm install

### Usage

- In other to use the repo you either to create a branch to create new features.
- But in order to run the project use the commands below:
- npm run build (It will create a production ready file)
- npm start (It will run the server on your local machine)

### Run Linters (Testing)

I have added Linters different kinds of Linters to help avoid typos and ensure the best practices of the code base.
So while using this repository if you need to check your work no matter if you have worked on HTML or CSS, or even JS you can use the commands below.

- To run the linter test on index.html or any HTML file. Use the below command:
npx hint .

-To run linter test on Stylesheets (CSS or sass). Use the below command:
npx Stylelint "**/*.{css,scss}"

- To run linter test on ES Lint (JS). Use the below command:
npx eslint .

(back to top)

## 👥 Authors

👤 **Author Glauber Bannwart**

- GitHub: [@cancelei](https://github.com/cancelei)
- LinkedIn: [LinkedIn](https://linkedin.com/in/gbannwart)

(back to top)

## 🔭 Future Features

- Implement advancements on features using Redux Toolkit;
- Add styling using CSS frameworks like Bootstrap or Material UI;
- Add user profiles;
- Add book recommendations based on user's reading history;
- Add book searching and filtering;
- Add book saving and wishlist;
- Add progress tracking for unfinished books;
- Add book reviews and rating system;
- Add "currently reading" and "want to read" book lists;

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome! Please consider this issue link: [Project Issues](https://github.com/cancelei/bookstore/issues)

## ⭐️ Show your support

If you like this project kindly leave a star!

(back to top)

## 🙏 Acknowledgments

We are gratefull of Microverse collaborators for creating such an amazing envirnment that we can work and learn.

## 📝 License

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

(back to top)