csn-tool

Critical Sites Network Tool 2.0

Data Management

This project uses a series of tables kept on a CARTO
as its data source. There are some tasks required to turn the source dataset
into the format that is required to make the application valid.

Details of this can be found on DATA_README.

Install

Requirements:

• NodeJs 8.9 How to install
• Heroku toolbet How to install

If you use nvm

nvm use

To install run this command:

yarn

Usage

Run server locally using yarn:

yarn start

Run server locally using Heroku environment:

heroku local web

Linters

Using Stylelint with webpack plugin for styles files.

Using Eslint for javascript files.

To make easier handle the errors it is recommended to use a text editor plugin, in atom:

1. Linter
2. Linter-Eslint
3. Linter-CssLint

apm install linter linter-eslint linter-csslint

Before git pushes use husky to avoid linter errors.
Use --no-verify just in case.

Deploy

Configure existing heroku app:

heroku git:remote -a project

Run this command to publish master branch to Heroku:

git push heroku master

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b feature/my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin feature/my-new-feature
5. Submit a pull request :D

LICENSE

MIT