Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hetrox8/book-store-refactor

Book Store is a website where Clients can review their status of the Books either Completed or in progress and providing a visual representation of how long they have read. The main languages used to achieve this include react.js and css
https://github.com/hetrox8/book-store-refactor

Last synced: 6 days ago
JSON representation

Book Store is a website where Clients can review their status of the Books either Completed or in progress and providing a visual representation of how long they have read. The main languages used to achieve this include react.js and css

Awesome Lists containing this project

README 

        
Bookstore



Awesome Books is a single page application (SPA) designed to help users to create their list of favourite books. This app lets users to add and delete books. The list is saved in local storage so that a user can refer to this list later. Built with React.



 



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



# 📖 "Bookstore" 



**Bookstore** is a single page application (SPA) designed to help users to create their list of favourite books.



- Add a new book by providing book title and author.

- Delete a particular book.



The list is saved in local storage so that a user can refer to this list later.



## 🛠 Built With 



### Tech Stack 



  Client

  


  Server

  
    

      



### Key Features 



- **Add a book**

- **Delete a book**

- **Navigate using nav links or address bar**



(back to top)



## 🚀 Live Demo 






(back to top)



## 💻 Getting Started 



To get a local copy up and running, follow these steps.



### Prerequisites



In order to run and modify this project you need:



- gitHub account;

- git installed on your OS;

- VSCode (or another code editor);

- modern browser (supporting HTML5 and CSS3) is highly recommended;

- [Node.js and npm](https://nodejs.org/) installed;



### Setup



Login to your GitHub account. Clone this repository to your desired folder:



> cd my-folder

> git clone [email protected]:zilola-nazarova/math-magicians.git



### Install



This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).



To install all dependencies run the following command:

> npm install



### Usage



You can use this project to:



- Create your list of Books by adding and deleting books.



To run the app in the development mode:

> npm start



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 launch the test runner in the interactive watch mode:

> npm test



You can also check linter errors by running this commands:

> npx stylelint "**/*.{css,scss}"


> npx eslint "**/*.{js,jsx}"



### Deployment



To build the app for production to the `build` folder.

> npm run build



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!



(back to top)



## 👥 Authors 



👤 Zilola Nazarova



- GitHub: [@suleiman_gacheru](https://github.com/hetrox8)

- LinkedIn: [in/suleiman-gacheru](https://www.linkedin.com/in/suleiman-gacheru)



(back to top)



## 🔭 Future Features 



- [ ] (is to be added in next projects)



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcomed!



(back to top)



## ⭐️ Show your support 



If you like this project just star it!



(back to top)



## 🙏 Acknowledgments 



I would like to thank Microverse program for the knowledge and skills I have acquired in Modules 1 and 2.



I am grateful for all previous project reviewers for their advice. Thanks to them I could build this app.



(back to top)



## ❓ FAQ 



- **is to be added in next projects**



  - (is to be added in next projects)



(back to top)



## 📝 License 



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



(back to top)