Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/johnftitor/book-store

This is a library project built using React with the main objective of learning how to use Redux with React. This is accomplished by holding a global state of the books displayed in the list, which are at the same time retrieved from an external API.
https://github.com/johnftitor/book-store

javascript react redux

Last synced: about 2 months ago
JSON representation

This is a library project built using React with the main objective of learning how to use Redux with React. This is accomplished by holding a global state of the books displayed in the list, which are at the same time retrieved from an external API.

Awesome Lists containing this project

README

        

#![](https://img.shields.io/badge/Microverse-blueviolet)

# Book Store

> This is a library project built using React with the main objective of learning how to use Redux with React. This is accomplished by holding a global state of the books displayed in the list, which are at the same time retrieved from an external API.

![Preview](./preview.gif)

Keep track of the books you've read through this library React Webpage. You can add them by writing their title and specifying their category. All the data will be displayed and sent to an external server. Share your books among all users!

## Live Version

[Netlify](https://jfbook-store.netlify.app)

[Heroku](https://jfbook-store.herokuapp.com/)

## Built With

- HTML/CSS and JavaScript
- React Framework
- Visual Studio Code

## Getting Started

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

- Clone this repository with git clone```https://github.com/JohnFTitor/book-store.git``` using your terminal or command line.
- Change to the project directory by entering :

```cd book-store``` in the terminal

### Prerequisites

You need to make sure to have installed the latest version of Node.js and npm on your computer.

### Setup

You can clone this repository or simply download the files as a .zip
If you want to set up a personal repository based on this one, you can as well fork it.

### Install

After clone it and before working on it, you have to run ```npm install``` so that all the dependencies of the project get downloaded in your pc locally.
Such dependencies include React app and linters checks, for which you have to install the files following the ```wget``` commands inside linters.yml file.

### Usage

You're free to use this project however you like it for educational purposes. Just keep in mind the acknowledgment described below

To work on the project, run ```npm start``` in your terminal to deploy a live version of the development. This works in watch mode so it automatically reloads any need change you make to the files.

### Run linters checks

Linter Checks are automatically run with Github actions when there's a pull request. If you want to run them locally, remember to have the config file in the root of the local project.

## Deployment

Netlify is set to automatically deploy the production branch (main branch) of this project, so you don't need to worry about it.
Heroku is manually deployed by our team whenever required. That is, when the main branch gets updated.

## Authors

πŸ‘€ **AndrΓ©s Felipe Arroyave Naranjo**

- GitHub: [@JohnFTitor](https://github.com/JohnFTitor)
- Twitter: [@johnftitor](https://twitter.com/johnftitor)
- LinkedIn: [Andres](https://www.linkedin.com/in/andresarroyavenaranjo/?locale=en_US)

## Show your support

Give a ⭐️ if you like this project!

## πŸ“ License

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