https://github.com/ashmalzahra/bookstore
The Bookstore website has been built in order to learn how to use React and Redux in the context of a real application. A Zeplin design has been parsed to create the UI.
https://github.com/ashmalzahra/bookstore
css-modules react react-bootstrap react-router redux redux-thunk rest-api single-page-app
Last synced: 2 months ago
JSON representation
The Bookstore website has been built in order to learn how to use React and Redux in the context of a real application. A Zeplin design has been parsed to create the UI.
- Host: GitHub
- URL: https://github.com/ashmalzahra/bookstore
- Owner: ashmalzahra
- License: mit
- Created: 2023-02-24T00:42:25.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-04-13T22:46:20.000Z (about 3 years ago)
- Last Synced: 2025-02-10T21:19:45.349Z (over 1 year ago)
- Topics: css-modules, react, react-bootstrap, react-router, redux, redux-thunk, rest-api, single-page-app
- Language: JavaScript
- Homepage:
- Size: 2.29 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 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)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
# 📖 Bookstore
The Bookstore is a website that allows you to:
- Display a list of books
- Add a book
- Remove a selected book
## Built With
- React.js
- Redux Toolkit
- VSCode and GitHub
Client
Server
Database
- N/A
### Key Features
- **[Git Flow]**
- **[Best practices for JavaScript]**
## Live Demo
[Live Demo Link](https://bookstore-bfbr.onrender.com/)
## 💻 Getting Started
Clone this repository to get started with the project, make sure to configure linters by following the instructions in the [Linters README file](https://github.com/microverseinc/linters-config/blob/master/README.md)
### Prerequisites
In order to run this project you need:
- A working computer.
- Connection to internet.
- [npm](https://www.npmjs.com/) and [Node.js](https://nodejs.org/en/) installed, if you don't have them, please follow this [simple installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
### Setup
- Clone the folder to your local machine.
- Open a local copy of the project in your code editor.
### Usage
- To run the project, execute the following command:
- npm start in your terminal.
- To run test functions, execute the following command:
- npm test in your terminal.
### Run tests
- After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.
- For stylelint errors run:npx stylelint "**/*.{css,scss}" --fix for automatic fix.
- For ESLINT errors run:npx eslint "**/*.{js,jsx}" --fix for automatic fix.
## 👥 Authors
👤 **Ashmal Zahra**
- GitHub: [@ashmalzahra](https://github.com/ashmalzahra)
- Twitter: [@AshmalZahraa](https://twitter.com/AshmalZahraa)
- LinkedIn: [ashmal-zahra](https://www.linkedin.com/in/ashmal-zahra)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ashmalzahra/bookstore/issues).
## ⭐️ Show your support
Give a ⭐️ if you like this project!
Design parse from [Zeplin Project](https://app.zeplin.io/project/5b35a9e13227086040f8eb75/screen/5b695e29bb8c844f118f9378)
- **Can I use the project for any purpose?**
- Yes, you can.
- **Is the information saved in any database?**
- No, all data is saved in Local Storage.
## 📝 License
This project is [MIT](./LICENSE) licensed.