umap/README.rst

88 lines
2.4 KiB
ReStructuredText
Raw Normal View History

2013-01-02 08:49:20 -06:00
uMap project
2012-11-20 03:47:19 -06:00
==============
About
-----
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''.*
2012-12-22 19:33:48 -06:00
It uses `django-leaflet-storage <https://github.com/yohanboniface/django-leaflet-storage>`_ and `Leaflet.Storage <https://github.com/yohanboniface/Leaflet.Storage>`_, built on top of Django and Leaflet.
2012-11-20 03:47:19 -06:00
Quickstart
----------
2012-11-26 14:32:51 -06:00
Create a geo aware database. See `Geodjango doc <https://docs.djangoproject.com/en/dev/ref/contrib/gis/install/>`_ for backend installation.
Create a virtualenv::
2013-01-02 08:49:20 -06:00
mkvirtualenv umap
2012-11-26 14:32:51 -06:00
Install dependencies and project::
2012-11-20 03:47:19 -06:00
2013-01-02 08:49:20 -06:00
cd path/to/umap/repository
2014-05-11 06:29:42 -05:00
git checkout 0.5.0
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
Create a default local settings file::
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
2012-11-26 14:32:51 -06:00
Add database connexion informations in `local.py`, for example::
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
}
}
2013-04-05 15:31:46 -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"
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"
Example of callback URL to use for settings up OAuth apps::
http://umap.foo.bar/complete/github/
Adapt the `STATIC_ROOT` and `MEDIA_ROOT` to your local environment.
2012-11-26 14:32:51 -06:00
Create the tables::
2013-01-08 12:52:05 -06:00
python manage.py syncdb --migrate
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
Start the server::
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:
2013-06-23 22:43:29 -05:00
- almost one license
2013-01-08 12:52:05 -06:00
- almost one tilelayer
Translating
-----------
2014-06-16 07:34:20 -05:00
Everything is managed through Transifex: https://www.transifex.com/projects/p/umap/