Getting started

To setup the Cat Tracker web application, complete the following steps:

1. Check and make sure that you have the necessary system requirements.

2. Clone the project and install the dependencies.

System requirements

You need a development environment with the upcoming LTS release candidate of Node.js (current release is version 14).

If you are using Windows, we recommend using the Windows Subsystem for Linux with Ubuntu 18.04 LTS.

Clone the project and install the dependencies

Clone the latest version of the Cat Tracker Web Application project and install the dependencies:

git clone https://github.com/bifravst/app.git bifravst-app
cd bifravst-app
npm ci

Set the environment EXTEND_ESLINT to true (It is needed for Create React App to pick up the custom eslint configuration).

The recommended workflow is to use a direnv plugin for your shell, which locates the environment variables in a .envrc file in the project folder and automatically exports them.

Create a new .envrc file in the project folder and add these environment variables by running the following command:

export EXTEND_ESLINT=true

Run the following command to allow the changed file:

direnv allow