Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fmanimashaun/bookstore-cms

Bookstore CMS is a web application that allows users to manage their bookstore. It allows users to add, remove, and edit books. It also allows users to add categories to books. The application is built with React and Redux.
https://github.com/fmanimashaun/bookstore-cms

es6-javascript react-icons reactjs router-dom sass

Last synced: 14 days ago
JSON representation

Bookstore CMS is a web application that allows users to manage their bookstore. It allows users to add, remove, and edit books. It also allows users to add categories to books. The application is built with React and Redux.

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/fmanimashaun-green)

## 📗 Table of Contents

- [📖 Bookstore CMS](#about-project)
- [Project Objectives](#project-objectives)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [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)

# 📖 Bookstore CMS

Bookstore CMS is a web application that allows users to manage their bookstore. It allows users to add, remove, and edit books. It also allows users to add categories to books. The application is built with React and Redux.

- [x] The application is a single-page app built with React and Redux.
- [x] The user can add a book.
- [x] The user can remove a book.
- [x] The user can edit a book's title and author.
- [x] The user can see a list of all the books.

## Project Objectives

- [x] create a React app and install basic dependencies as React-Redux.
- [x] create routes and view components (Routers for the app).

(back to top)

## 🛠 Built With

### Tech Stack

- [react](https://react.dev/)
- [npm](https://www.npmjs.com/)
- [Git](https://git-scm.com/)
- [GitHub](https://github.com)
- [Stylelint](https://stylelint.io/)
- [ESLint](https://eslint.org/)
- [sass](https://sass-lang.com/)
- [VSCode](https://code.visualstudio.com/)
- [react router](https://reactrouter.com/)
- [react redux](https://react-redux.js.org/)
- [redux-toolkit](https://redux-toolkit.js.org/)
- [react icons](https://react-icons.github.io/react-icons/)

### Key Features

- [x] The user can add a book.
- [x] The user can remove a book.
- [x] The user can see a list of all the books.
- [x] the user can change page

(back to top)

## 🚀 Live Demo

> [Live Demo Link](https://fmanimashaun.github.io/bookstore-cms/)







(back to top)

## 💻 Getting Started

### Prerequisites

- [Optional] Install git bash to your machine to enable you to clone this repo.
- install Visual Studio to be able to host a local live version.
- Install a browser to view the local live version.

To get a local copy up and running follow these simple example steps.
### Setup

Clone this repository to your desired folder:

```sh
cd your-desired-folder
git clone https://github.com/fmanimashaun/bookstore-cms.git
open the repo folder `bookstore-cms`
```

### Install

Install this project dependencies with:

```sh
npm install
```

### Usage

To run the project, execute the following command:

```sh
npm run start
```

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### Run tests

To run tests to check the lint errors, run the following command:

- To check for CSS lint errors, run the following command:

```sh
npm run stylelint
```

- To check for JS lint errors, run the following command:

```sh
npm run eslinter
```

To run unit tests, run the following command:

```sh
npm run test
```

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### Deployment

You can deploy this project to github pages by running the following command:

```sh
npm run deploy

```

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
and it is automatically deployed to the github page.

See the section about [github page deployment](https://github.com/gitname/react-gh-pages) for more information.

(back to top)

## Authors

👤 **Engr. Animashaun Fisayo**

- [GitHub](https://github.com/fmanimashaun)
- [Twitter](https://twitter.com/fmanimashaun)
- [LinkedIn](https://www.linkedin.com/in/fmanimashaun/)
- [Website](https://fmanimashaun.com)

(back to top)

## 🔭 Future Features

- [ ] Add various page components.
- [ ] Upgrade the book card with new interactive functures
- [ ] Add a progress bar to show the progress of the book.

(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

Give a ⭐️ if you like this project!

(back to top)

## 🙏 Acknowledgements

- [Microverse](https://www.microverse.org/)

(back to top)

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

(back to top)