README.md 2.37 KB
Newer Older
1
2
# Gribrouillon

3
4
![Logo](src/website/img/logo.400.png)

5
Gribrouillon ([gribrouillon.fr](https://gribrouillon.fr)) makes drawing over web maps easy. You can create sketchy maps in seconds, on mobile or desktop. [Give it a try !](https://gribrouillon.fr/)
6

Adrien Pavie's avatar
Adrien Pavie committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
## Contributing

Interested in helping us ? No worries, you don't need to be a developer to do so. Here are some ways to help improving Gribrouillon :

* There is a bug or some feature missing ? You can either send us [an email](mailto:panieravide@riseup.net) or [create a new issue](https://framagit.org/PanierAvide/gribrouillon/issues) on the repository.
* If you speak English and another language, you can [help translate the tool](https://www.transifex.com/openlevelup/gribrouillon/) on Transifex.
* And as always, you can help solve bugs or implement feature if you know code.


## Contributors

Gribrouillon exists and is everyday improving thanks to the __amazing people__ following :

* Adrien Pavie, main developer
* Florian Lainez, user experience expert
Adrien Pavie's avatar
Adrien Pavie committed
22
* Trendspotter and idetao, for their translations
Adrien Pavie's avatar
Adrien Pavie committed
23
24
25
* And all users, for using the tool and sharing their ideas !


26
27
## Deploy your own instance

Adrien Pavie's avatar
Adrien Pavie committed
28
If you want to have your own Gribrouillon server running (either for developing or hosting), you can follow these instructions.
29

30
31
32
33
34
35
36
### Requirements

To run properly, Gribrouillon needs following software to be available :

* PostgreSQL >= 10
* PostGIS >= 2.4
* NodeJS >= 9
Adrien Pavie's avatar
Adrien Pavie committed
37
* Only for updating translations : [Transifex CLI](https://docs.transifex.com/client/installing-the-client)
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

### Install

```bash
# Retrieve source code
git clone https://framagit.org/PanierAvide/gribrouillon.git
cd gribrouillon

# Install JS dependencies
npm install

# Setup database
psql -c "CREATE DATABASE gribrouillon ENCODING 'UTF8'"
psql -d gribrouillon -f src/init.sql
```

### Configure

Edit `config.json` file according to your PostgreSQL setup.

### Run

```bash
npm run start
62

Adrien Pavie's avatar
Adrien Pavie committed
63
64
65
# Or alternatively, if you want to change port
PORT=12345 npm run start
```
66

67
68
69
70
71
Environment variables which can be used for API :

* `PORT` : for changing listening port (defaults to 3000)
* `BG_DL` : for setting how to retrieve background imagery file (values being `0` to disable usage, `1` for downloading from Internet, and `2` for reading from `res/imagery.geojson` file)

72
73
74
75
76
77

## License

Copyright (c) Adrien Pavie 2020

Released under AGPL 3 license, see [LICENSE](LICENSE.txt) for complete license text.