Listy Application

This is a simple micro CRUD application built in React + Redux. The application is consuming the https://jsonplaceholder.typicode.com/ dummy json API.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You need node inorder to run the application locally. for OS specific instructions, you can go thought this guide. Installing Node.

An alternative is installing a version manager inorder to easily run different versions of node. My favorite is asdf.

This project was developed with Node v8.

Installing

These are instructions to get you up and running locally.

Note: You can also use yarn.

First clone the repository and change into the directory:

git clone https://github.com/Habu-Kagumba/listy-app.git

Change into the directory, these command may vary according to your OS. For Linux, the command would be cd listy-app. Next you need to install project dendencies using npm:

npm install

To start the development server, runthis command. For OSX users, this will automatically open the page for you on the browser.

npm run start

The application looks like this:

Manual build

You can build the project which will create a build folder in the project root directory.

npm run build

Testing

The project uses Jest. To run the tests, use this command:

npm run test

To also include coverage, you can run:

npm run coverage

Linting

The project uses ES-Lint, the command to link the project is:

npm run lint