diff --git a/docs/contributing.md b/docs/contributing.md index 615fe0f6..e81e069d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -3,3 +3,82 @@ ## Translating Translation is managed through [Transifex](https://www.transifex.com/yohanboniface/umap/dashboard/). + +## Bugs Triaging + +You are very welcome to help us triaging [uMap issues](https://github.com/umap-project/umap/issues). + +* Help other users by answering questions +* Give your point of view in discussions +* And so on... + +## Development on Ubuntu + +### Environnement setup + +Follow the procedure [Ubuntu from scratch](ubuntu.md) + +But instead using folders /etc/umap, you can create a ~/.umap folder. +This folder will contain the umap.conf file. + +And for folder /srv/umap, you can create a ~/umap folder (We will remove this folder later) + +You will have to set an env var, we will set it in your .bashrc: + + nano ~/.bashrc + +Add the following at the end of file: + +``` +# uMap +export UMAP_SETTINGS=~/.umap/umap.conf +``` + +Then refresh your terminal + + source ~/.bashrc + +Run your local uMap and check that it is working properly. + +### Hacking on the code + +Create a workspace folder ~/wk and go into it. + +"git clone" the main repository and go in the umap folder + +Several commands, needs you to be in a virtualenv: + + virtualenv ~/wk/umap/venv --python=/usr/bin/python3.6 + source /srv/umap/venv/bin/activate + +Now, command "umap" will be available + +*Note: if you close your terminal, you will need to re-run command:* + + source /srv/umap/venv/bin/activate + +To test your code, you will add to install umap from your git folder. Go to ~/wk/umap and run: + + pip install -e . + # or pip install -e ~/wk/umap + +This command, will check dependencies and install uMap from sources inside folder. + +To start your local uMap: + + umap runserver 0.0.0.0:8000 + +### Update translations + +Install needed tools: + + apt install gettext transifex-client + +Pull the translations from transifex website: + + tx pull -f + +Then you will need to update binary files with command: + make compilemessages + +Done. You can now review and commit modified/added files. \ No newline at end of file diff --git a/docs/install.md b/docs/install.md index 93c9ed90..9324ed1e 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,5 +1,7 @@ # Installation +*Note: for Ubuntu follow procedure [Ubuntu from scratch](ubuntu.md)* + Create a geo aware database. See [Geodjango doc](https://docs.djangoproject.com/en/dev/ref/contrib/gis/install/) for backend installation. Create a virtual environment diff --git a/docs/ubuntu.md b/docs/ubuntu.md index 48072b0d..fabd9cc7 100644 --- a/docs/ubuntu.md +++ b/docs/ubuntu.md @@ -6,8 +6,9 @@ You need sudo grants on this server, and it must be connected to Internet. ## Install system dependencies - sudo apt install build-essential autoconf python3.5 python3.5-dev python-virtualenv wget nginx uwsgi uwsgi-plugin-python3 postgresql-9.5 postgresql-server-dev-9.5 postgresql-9.5-postgis-2.2 git libxml2-dev libxslt1-dev zlib1g-dev + sudo apt install build-essential autoconf python3.6 python3.6-dev python-virtualenv wget nginx uwsgi uwsgi-plugin-python3 postgresql-9.5 postgresql-server-dev-9.5 postgresql-9.5-postgis-2.2 git libxml2-dev libxslt1-dev zlib1g-dev +*Note: nginx and uwsgi are not required for local development environment* *Note: uMap also works with python 2.7 and 3.4, so adapt the package names if you work with another version.* @@ -58,7 +59,7 @@ From now on, unless we say differently, the commands are run as `umap` user. ## Create a virtualenv and activate it - virtualenv /srv/umap/venv --python=/usr/bin/python3.5 + virtualenv /srv/umap/venv --python=/usr/bin/python3.6 source /srv/umap/venv/bin/activate *Note: this activation is not persistent, so if you open a new terminal window, @@ -74,6 +75,16 @@ you will need to run again this last line.* wget https://raw.githubusercontent.com/umap-project/umap/master/umap/settings/local.py.sample -O /etc/umap/umap.conf +## Customize umap.conf + + nano /etc/umap/umap.conf + +Change the following properties: + +``` +STATIC_ROOT = '/srv/umap/var/static' +MEDIA_ROOT = '/srv/umap/var/data' +``` ## Create the tables