https://github.com/tanveerisonline/bookstore-app
This project is a React Single Page App. In this project you can Add books and delete books. This project is using React Router. This project is using best practices with React and JavaScript. This project follows the Gitflow convention.
https://github.com/tanveerisonline/bookstore-app
gitflow javascript react react-router
Last synced: about 1 month ago
JSON representation
This project is a React Single Page App. In this project you can Add books and delete books. This project is using React Router. This project is using best practices with React and JavaScript. This project follows the Gitflow convention.
- Host: GitHub
- URL: https://github.com/tanveerisonline/bookstore-app
- Owner: tanveerisonline
- License: mit
- Created: 2023-01-18T19:34:21.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-27T17:03:26.000Z (over 2 years ago)
- Last Synced: 2025-03-26T22:45:14.991Z (about 2 months ago)
- Topics: gitflow, javascript, react, react-router
- Language: JavaScript
- Homepage:
- Size: 1.22 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
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)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
> Book store app is a react based app where we can add and remove books.
> Following technologies have been used in this project.
Client
Server
> This project is a React Single Page App.
> In this project you can Add books and delete books.
> This project is using React Router.
> This project is using best practices with React and JavaScript.
> This project follows the gitflow convention.
> This is using eslint and stylelint to check errors.
> This project is using Github Actions to check linters errors.
> This project is using react-redux to manage state.
## 🚀 Live Demo Live Link
> This is how a new developer could make use this project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- [ ] A PC or Mac.
- [ ] An active internet connection.
- [ ] Some knowledge of git and github.
### Setup
Clone this repository by using the command line : git clone https://github.com/tanveerisonline/bookstore-app.git
### Install
Install this project with:
Use npm install after cloning this project
### Usage
- [ ] First you need to download this repo or clone this repo.
- [ ] Open this project in your local machine.
- [ ] Open Terminal in your machine.
- [ ] run npm install in your terninal to install necessary required dependencies for this project.
- [ ] Copy index.html file path and paste it in your browser url.
- [ ] now the project will be running.
### Deployment
You can deploy this project using:
Github Pages.
> Mention all of the collaborators of this project.
👤 **Author1**
- GitHub: [@tanveerisonline](https://github.com/tanveerisonline)
> Following are a few features i will add to the project in future.
- [ ] I will add a database to this project in future where i can save user data.
- [ ] I will add more functionality to this project like book search, author search etc.
- [ ] I will update the interface and design of the project in future.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you're committed to making the world a better place, please support our project.
I would like to give credit to the following people who have inspired my codebase:
- [ ] The Whole Microverse Team - thank you so much for this great learning platform.
- **[Question_1]** What technologies i have used in this project ?
- [Answer_1]:Thanks for the question you can find the answer at the top section of this readme.md file where i have explained everything.
- **[Question_2]** Have you used webpack in this project ?
- [Answer_2] Yes i have used webpack 5 in this project.
This project is [MIT](./LICENSE.md) licensed.
\_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish.