https://github.com/luigirazum/mv-bookspot-app
BookSpot is a website that allows you to: 1) Display a list of books, 2) Add a book and, 3) Remove a selected book. This project was built in order to learn how to use React and Redux in the context of a real application.
https://github.com/luigirazum/mv-bookspot-app
Last synced: 5 months ago
JSON representation
BookSpot is a website that allows you to: 1) Display a list of books, 2) Add a book and, 3) Remove a selected book. This project was built in order to learn how to use React and Redux in the context of a real application.
- Host: GitHub
- URL: https://github.com/luigirazum/mv-bookspot-app
- Owner: luigirazum
- License: mit
- Created: 2023-03-31T00:36:33.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-04-10T05:14:19.000Z (over 2 years ago)
- Last Synced: 2025-04-01T05:11:08.447Z (7 months ago)
- Language: JavaScript
- Size: 1.43 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### BookSpot App
BookSpot App is the MVP of a [SPA](https://en.wikipedia.org/wiki/Single-page_application) application that lets users to:
1) Display a list of books,
2) Add a book and,
3) Remove a selected book.
This project was built in order to learn how to use React and Redux in the context of a real application.
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📘 BookSpot App](#about-project)
- [Preview BookSpot App](#preview-of-bookspot-app)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Available Scripts](#available-scripts)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [⭐ Show your support ](#-show-your-support-)
- [📝 License ](#-license-)
*BookSpot App* is the MVP of a [SPA](https://en.wikipedia.org/wiki/Single-page_application) application that lets users display a list of books, add a book to the list and, remove a selected book.
This project was built in order to learn how to use React and Redux in the context of a real application.
### Preview of BookSpot App.
This is a preview of how the BookSpot App will look once finished.
## 🛠 Built With
### Tech Stack
This project was bootstrapped with:
React
Create React App
Redux Toolkit- *Display a list of books*
- *Add new books to the list*
- *Remove a selected book*
To get a local copy of this project up and running, follow these steps.
- ### Prerequisites
- In order to run this project locally you need `git` installed. Please got to [Getting Started - Installing Git guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and follow the steps described for your system to install `git`.
- You must have Node installed on our machine to access the NPM (Node Package Manager) tool.
Run `node -v` and `npm -v` in the terminal to see if you have node and npm installed, respectively. Ensure you have node>=14.0.0 and npm>=5.6\
If you don’t have them installed, head to [Node](https://nodejs.org/) to download and install the latest stable version.
- ### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone git@github.com:luigirazum/mv-bookspot-app.git
```
- ### Install
Install the package dependencies for this project with:
```sh
cd mv-bookspot-app
npm install
```
### Available Scripts
- #### Run
In the project directory, you can run:
```sh
npm 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.
- #### Test
```sh
npm 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.
- #### Build
```sh
npm run build
```
- 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.
- Your app is ready to be deployed!\
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
- #### Deploy
```sh
npm deploy
```
- Deploys the project using `gh-pages`.
- Under the hood, it runs `npm run build` first.
- The project then is published using github pages.
👨💻 **Luis Zubia**
- GitHub: **@luigirazum**
- Twitter: **@LuigiRazum**
- LinkedIn: **Luis Zubia**
- [ ] *Make the list of books to be stored with the help of an API.*
- [ ] *Have a search input to filter the list of books.*
In order to improve this project, contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## 🙏 Acknowledgments
- 👏 I would like to thank the support of my partners.
- 👏 Also thanks to [**Usman Suleiman Babakolo**](https://github.com/usmansbk) a Micronaut who provided a live working demo of how this project should look finished. You can check it out clicking the next [**Bookstore CMS**](https://pedantic-beaver-cb923b.netlify.app/#/) link.
I really enjoyed making this project, so, if you like it, I appreciate your support giving a ⭐.
This project is [MIT](./LICENSE) licensed.