emilianoarlettaz / reactskeletor

A basic React App to start projects

React Skeletor App

A basic frontend React App to start new projects.

Installation

Download the repository directory:

git clone [email protected]:emilianoarlettaz/reactskeletor.git
cd reactskeletor

Set the required NodeJS version:

nvm install

This assumes you have NVM installed on your computer, if not, you can install it from here.

Install the repository hooks:

npm run install-hooks

This will ensure the code is validated before committing changes and that the dependencies will be updated if you do git pull and there are new dependencies.

Install the project dependencies:

npm install

You should always run nvm install before doing npm install or git pull as the dependencies MUST be installed with the version of NodeJS required by this project.

Running the project

To start the project with the default configuration on your local environment run the following command:

npm start

Now, you can open the browser and visit http://localhost:8080/

Running Unit and Integration tests:

npm run test:unit

You should also see a coverage report after test running.

Running Snapshot tests:

npm run test:snapshot

Quality Assurance

This project runs ESLint and executes all unit, integration and snapshot tests every time you want to commit changes. For this you should install the hooks (see installation guide).

If you want to run manually the Linter execute the following command:

npm run lint:js:full

This project follows Airbnb JavaScript Style