https://github.com/vizzuality/csn-tool
Critical Sites Network Tool 2.0
https://github.com/vizzuality/csn-tool
biodiversity birds conservation react waterbirds
Last synced: 3 months ago
JSON representation
Critical Sites Network Tool 2.0
- Host: GitHub
- URL: https://github.com/vizzuality/csn-tool
- Owner: Vizzuality
- License: mit
- Created: 2016-09-30T18:08:17.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T17:13:33.000Z (over 3 years ago)
- Last Synced: 2024-06-11T17:23:58.162Z (about 2 years ago)
- Topics: biodiversity, birds, conservation, react, waterbirds
- Language: JavaScript
- Size: 3.79 MB
- Stars: 1
- Watchers: 6
- Forks: 1
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# csn-tool
Critical Sites Network Tool 2.0
## Data Management
This project uses a series of tables kept on a [CARTO](https://www.carto.com)
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](DATA_README.md).
## Install
Requirements:
* NodeJs 8.9 [How to install](https://nodejs.org/download/)
* Heroku toolbet [How to install](https://toolbelt.heroku.com)
If you use `nvm`
```bash
nvm use
```
To install run this command:
```bash
yarn
```
## Usage
Run server locally using yarn:
```bash
yarn start
```
Run server locally using Heroku environment:
```bash
heroku local web
```
### Linters
Using [Stylelint](https://github.com/stylelint/stylelint) with webpack plugin for styles files.
Using [Eslint](http://eslint.org/) for javascript files.
To make easier handle the errors it is recommended to use a text editor plugin, in atom:
1. [Linter](https://atom.io/packages/linter)
2. [Linter-Eslint](https://atom.io/packages/linter-eslint)
3. [Linter-CssLint](https://atom.io/packages/linter-csslint)
```bash
apm install linter linter-eslint linter-csslint
```
Before git pushes use [husky](https://github.com/typicode/husky) to avoid linter errors.
Use `--no-verify` just in case.
### Deploy
Configure existing heroku app:
```bash
heroku git:remote -a project
```
Run this command to publish master branch to Heroku:
```bash
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](LICENSE)