Web application to explore Renewable Energy Zones.
The following steps will walk through setting up a development environment. Please check this file for more details on development process.
Requirements:
Clone this repository locally and activate required Node.js version:
nvm install
Install Node.js dependencies:
yarn install
The config files can be found in app/assets/scripts/config. After installing the project, there will be an empty local.js that you can use to set the config. This file should not be committed. More details on config file can be found here.
Start server with live code reload at http://localhost:9000:
yarn serve
Jest is available for unit testing on components:
yarn test
Integration testing is done with Cypress:
yarn cy:test
To develop new tests with Cypress, start the development server and run:
yarn run cypress open
This will generate a minified build to dist folder:
yarn build
The application uses GADM national and sub-national boundaries to perform analysis.
The geofiles are served from the website public folder and loaded at runtime. The files can be generated/updated by running the following script:
./scripts/create_regions.sh
This will download GADM data to .tmp, parse and copy the results to app/public folder. The files are already included in the directory, so the script should be executed only when the source files change.