umap/README.md

104 lines
3.1 KiB
Markdown
Raw Normal View History

2015-09-23 02:44:17 -05:00
[![Requirements Status](https://requires.io/github/umap-project/umap/requirements.svg?branch=master)](https://requires.io/github/umap-project/umap/requirements/?branch=master)
2015-08-02 15:10:41 -05:00
# uMap project
## About
2012-11-20 03:47:19 -06:00
2013-06-23 22:43:29 -05:00
uMap lets you create maps with OpenStreetMap layers in a minute and embed them in your site.
*Because we think that the more OSM will be used, the more OSM will be ''cured''.*
2015-08-02 15:10:41 -05:00
It uses [django-leaflet-storage](https://github.com/umap-project/django-leaflet-storage) and [Leaflet.Storage](https://github.com/umap-project/Leaflet.Storage), built on top of Django and Leaflet.
2015-08-02 15:10:41 -05:00
## Quickstart
2012-11-20 03:47:19 -06:00
2015-08-02 15:10:41 -05:00
Create a geo aware database. See [Geodjango doc](https://docs.djangoproject.com/en/dev/ref/contrib/gis/install/) for backend installation.
2012-11-26 14:32:51 -06:00
2015-08-02 15:10:41 -05:00
Create a virtual environment
2012-11-26 14:32:51 -06:00
virtualenv umap
source umap/bin/activate
2012-11-26 14:32:51 -06:00
2015-08-02 15:10:41 -05:00
Install dependencies and project
2012-11-20 03:47:19 -06:00
cd YOUR_SOURCE_DIR
2015-09-23 02:17:44 -05:00
git clone git@github.com:umap-project/umap.git
2014-06-16 07:34:20 -05:00
pip install -r requirements.txt
2012-11-20 03:47:19 -06:00
pip install -e .
2012-11-26 14:32:51 -06:00
2015-08-02 15:10:41 -05:00
Create a default local settings file
2012-11-26 14:32:51 -06:00
2013-05-14 05:48:09 -05:00
cp umap/settings/local.py.sample umap/settings/local.py
2013-01-08 12:52:05 -06:00
2015-08-02 15:10:41 -05:00
Add database connexion informations in `local.py`, for example
2012-11-26 14:32:51 -06:00
DATABASES = {
'default': {
'ENGINE': 'django.contrib.gis.db.backends.postgis',
2013-01-02 08:49:20 -06:00
'NAME': 'umap',
2012-11-26 14:32:51 -06:00
}
}
2015-08-02 15:10:41 -05:00
Add a `SECRET_KEY` in `local.py` with a long random secret key
SECRET_KEY = "a long and random secret key that must not be shared"
2015-08-02 15:10:41 -05:00
uMap uses [django-social-auth](http://django-social-auth.readthedocs.org/) for user authentication. So you will need to configure it according to your
needs. For example
AUTHENTICATION_BACKENDS = (
'social_auth.backends.contrib.github.GithubBackend',
'social_auth.backends.contrib.bitbucket.BitbucketBackend',
'social_auth.backends.twitter.TwitterBackend',
'django.contrib.auth.backends.ModelBackend',
)
GITHUB_APP_ID = 'xxx'
GITHUB_API_SECRET = 'zzz'
BITBUCKET_CONSUMER_KEY = 'xxx'
BITBUCKET_CONSUMER_SECRET = 'zzz'
TWITTER_CONSUMER_KEY = "xxx"
TWITTER_CONSUMER_SECRET = "yyy"
2015-08-02 15:10:41 -05:00
Example of callback URL to use for setting up OAuth apps
http://umap.foo.bar/complete/github/
Adapt the `STATIC_ROOT` and `MEDIA_ROOT` to your local environment.
2015-08-02 15:10:41 -05:00
Create the tables
2012-11-26 14:32:51 -06:00
python manage.py migrate
2013-01-08 12:52:05 -06:00
2015-08-02 15:10:41 -05:00
Collect and compress the statics
2013-01-08 12:52:05 -06:00
python manage.py collectstatic
2013-01-08 12:52:05 -06:00
python manage.py compress
2012-11-26 14:32:51 -06:00
2015-08-02 15:10:41 -05:00
Add a site object
python manage.py shell
from django.contrib.sites.models import Site
Site.objects.create(name='example.com', domain='example.com')
2015-08-02 15:10:41 -05:00
Start the server
2012-11-26 14:32:51 -06:00
python manage.py runserver 0.0.0.0:8000
2013-01-08 12:52:05 -06:00
Go to the admin (http://localhost:8000/admin/) and add:
- at least one license
- at least one tile layer
2015-08-02 15:10:41 -05:00
## Search
UMap uses Postgresql tsvector for searching. It case your database is big, you
may want to add an index. For that, you sould do so:
CREATE EXTENSION unaccent;
CREATE EXTENSION btree_gin;
ALTER FUNCTION unaccent(text) IMMUTABLE;
ALTER FUNCTION to_tsvector(text) IMMUTABLE;
CREATE INDEX search_idx ON leaflet_storage_map USING gin(to_tsvector(unaccent(name)), share_status);
2015-08-02 15:10:41 -05:00
## Translating
2014-06-16 07:34:20 -05:00
Everything is managed through Transifex: https://www.transifex.com/projects/p/umap/