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

https://github.com/flacode/shopping-list-react

ReactJS client to consume the API developed in https://github.com/flacode/shopping_list
https://github.com/flacode/shopping-list-react

Last synced: about 1 year ago
JSON representation

ReactJS client to consume the API developed in https://github.com/flacode/shopping_list

Awesome Lists containing this project

README

          

# ShoppingList
[![Build Status](https://travis-ci.org/flacode/shopping-list-react.svg?branch=develop)](https://travis-ci.org/flacode/shopping-list-react) [![Test Coverage](https://api.codeclimate.com/v1/badges/f61b4fe09939223c9636/test_coverage)](https://codeclimate.com/github/flacode/shopping-list-react/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/f61b4fe09939223c9636/maintainability)](https://codeclimate.com/github/flacode/shopping-list-react/maintainability)
> ShoppingList is an application that allows users to record, share and keep track of their shopping lists. This application already has an API hosted [here](https://deployment-shopping-list-api.herokuapp.com). Details about the API can be found both in its [documentation](https://shoppinglist12.docs.apiary.io/#) and [Github repository](https://github.com/flacode/shopping_list). This project builds a ReactJS client to consume this API.

## Live site
You can interact with the application [here](https://shoppingug.herokuapp.com/).

## Features
- Users can create accounts.
- Users can log in.
- Users can create, view, update and delete shopping lists.
- Users can add, update, view or delete items in a shopping list.

## Tools used
Tools used for development of this client are;
- Creating the application : [create-react-app](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started)
- Editor: [Vs code](https://code.visualstudio.com)
- Programming language: [Javascript ES6](http://es6-features.org/#Constants)
- Library: [React](https://reactjs.org)
- Linting: [EsLint](https://eslint.org)

## How to set up?
- Create a directory and change to that directory
```sh
> mkdir shopping-list
> cd shopping-list
```
- Clone this repository.
```sh
> git clone https://github.com/flacode/shopping-list-react.git
```
- Install the required dependencies.
```sh
> cd shopping-list-react
> npm install
```
- Run the application.
```sh
> npm start
```
- Enter http://localhost:3000 in your browser to interact with your local version of your application.

## Running the tests
- In the root repository, run
```sh
> npm test
```