Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
@ad-m
ad-m committed Aug 27, 2016
1 parent 2dcf896 commit 60b3324
Showing 1 changed file with 29 additions and 169 deletions.
198 changes: 29 additions & 169 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,192 +21,52 @@ Mechanizm do automatycznego wysyłania wniosków o informację do dużej liczby

LICENSE: BSD

Settings
------------

feder relies extensively on environment settings which **will not work with Apache/mod_wsgi setups**. It has been deployed successfully with both Gunicorn/Nginx and even uWSGI/Nginx.

For configuration purposes, the following table maps the 'feder' environment variables to their Django setting:

======================================= =========================== ============================================== ======================================================================
Environment Variable Django Setting Development Default Production Default
======================================= =========================== ============================================== ======================================================================
DJANGO_CACHES CACHES (default) locmem memcached
DJANGO_DATABASES DATABASES (default) See code See code
DJANGO_DEBUG DEBUG True False
DJANGO_SECRET_KEY SECRET_KEY CHANGEME!!! raises error
DJANGO_SECURE_BROWSER_XSS_FILTER SECURE_BROWSER_XSS_FILTER n/a True
DJANGO_SECURE_SSL_REDIRECT SECURE_SSL_REDIRECT n/a True
DJANGO_SECURE_CONTENT_TYPE_NOSNIFF SECURE_CONTENT_TYPE_NOSNIFF n/a True
DJANGO_SECURE_FRAME_DENY SECURE_FRAME_DENY n/a True
DJANGO_SECURE_HSTS_INCLUDE_SUBDOMAINS HSTS_INCLUDE_SUBDOMAINS n/a True
DJANGO_SESSION_COOKIE_HTTPONLY SESSION_COOKIE_HTTPONLY n/a True
DJANGO_SESSION_COOKIE_SECURE SESSION_COOKIE_SECURE n/a False
DJANGO_DEFAULT_FROM_EMAIL DEFAULT_FROM_EMAIL n/a "feder <noreply@dane.siecobywatelska.pl>"
DJANGO_SERVER_EMAIL SERVER_EMAIL n/a "feder <noreply@dane.siecobywatelska.pl>"
DJANGO_EMAIL_SUBJECT_PREFIX EMAIL_SUBJECT_PREFIX n/a "[feder] "
======================================= =========================== ============================================== ======================================================================

The following table lists settings and their defaults for third-party applications:

======================================= =========================== ============================================== ======================================================================
Environment Variable Django Setting Development Default Production Default
======================================= =========================== ============================================== ======================================================================
DJANGO_AWS_ACCESS_KEY_ID AWS_ACCESS_KEY_ID n/a raises error
DJANGO_AWS_SECRET_ACCESS_KEY AWS_SECRET_ACCESS_KEY n/a raises error
DJANGO_AWS_STORAGE_BUCKET_NAME AWS_STORAGE_BUCKET_NAME n/a raises error
DJANGO_MAILGUN_API_KEY MAILGUN_ACCESS_KEY n/a raises error
DJANGO_MAILGUN_SERVER_NAME MAILGUN_SERVER_NAME n/a raises error
======================================= =========================== ============================================== ======================================================================

Getting up and running
----------------------

Basics
^^^^^^

The steps below will get you up and running with a local development environment. We assume you have the following installed:

* pip
* virtualenv
* PostgreSQL

First make sure to create and activate a virtualenv_, then open a terminal at the project root and install the requirements for local development::

$ pip install -r requirements/local.txt

.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/

Create a local PostgreSQL database::

$ createdb feder

Run ``migrate`` on your new database::

$ python manage.py migrate

You can now run the ``runserver_plus`` command::

$ python manage.py runserver_plus

Open up your browser to http://127.0.0.1:8000/ to see the site running locally.

Setting Up Your Users
^^^^^^^^^^^^^^^^^^^^^

To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

To create an **superuser account**, use this command::

$ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Live reloading and Sass CSS compilation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you'd like to take advantage of live reloading and Sass / Compass CSS compilation you can do so with a little bit of prep work.

Make sure that nodejs_ is installed. Then in the project root run::
The steps below will get you up and running with a local development environment. We assume you have the following installed
First make sure to install all requires OS-level libraries and application (dependencies)::

$ npm install
$ sudo apt-get install python2.7 mariadb-server git libmariadbclient-dev virtualenv python-dev libffi-dev libssl-dev libjpeg-dev libpng12-dev libxml2-dev libxslt1-dev build-essential libjpeg62

.. _nodejs: http://nodejs.org/download/
Next to create and activate a virtualenv_::

If you don't already have it, install `compass` (doesn't hurt if you run this command twice)::
$ virtualenv env
$ source env/bin/activate

gem install compass
.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/

Now you just need::
Next to open a terminal at the project root and install the requirements for local development::

$ grunt serve

The base app will now run as it would with the usual ``manage.py runserver`` but with live reloading and Sass compilation enabled.

To get live reloading to work you'll probably need to install an `appropriate browser extension`_

.. _appropriate browser extension: http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions-



It's time to write the code!!!


Deployment
------------

It is possible to deploy to Heroku or to your own server by using Dokku, an open source Heroku clone.

Heroku
^^^^^^

Run these commands to deploy the project to Heroku:

.. code-block:: bash
heroku create --buildpack https://github.com/heroku/heroku-buildpack-python
heroku addons:create heroku-postgresql:hobby-dev
heroku pg:backups schedule DATABASE_URL --at "04:00 UTC"
heroku pg:promote DATABASE_URL
$ pip install pip wheel -U
$ pip install -r requirements/local.txt

heroku addons:create mailgun
heroku addons:create memcachier:dev
Next to create MySQL database::

heroku config:set DJANGO_SECRET_KEY=RANDOM_SECRET_KEY_HERE
heroku config:set DJANGO_SETTINGS_MODULE='config.settings.production'
# if you are using Ubuntu 14.04, you may need to find a workaround for the following two commands
$ sudo systemctl start mariadb
$ sudo systemctl enable mariadb
heroku config:set DJANGO_AWS_ACCESS_KEY_ID=YOUR_AWS_ID_HERE
heroku config:set DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY_HERE
heroku config:set DJANGO_AWS_STORAGE_BUCKET_NAME=YOUR_AWS_S3_BUCKET_NAME_HERE
heroku config:set MAILGUN_SERVER_NAME=$(heroku config:get MAILGUN_DOMAIN | cut -d"=" -f2-)
heroku config:set DJANGO_SERVER_EMAIL="smtp://$(heroku config:get MAILGUN_SMTP_LOGIN | cut -d"=" -f2- | sed 's/@/%40/' ):$(heroku config:get MAILGUN_SMTP_PASSWORD | cut -d"=" -f2-)@$(heroku config:get MAILGUN_SMTP_SERVER | cut -d"=" -f2-)"
git push heroku master
heroku run python manage.py migrate
heroku run python manage.py check --deploy
heroku run python manage.py createsuperuser
heroku open
Dokku
^^^^^

You need to make sure you have a server running Dokku with at least 1GB of RAM. Backing services are
added just like in Heroku however you must ensure you have the relevant Dokku plugins installed.

.. code-block:: bash
$ mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
$ echo "CREATE DATABASE feder CHARACTER SET utf8 COLLATE utf8_polish_ci;" | mysql -u root
$ echo "CREATE USER 'user'@'localhost' IDENTIFIED BY 'pass';" | mysql -u root
$ echo "GRANT ALL PRIVILEGES ON feder . * TO 'user'@'localhost'; FLUSH PRIVILEGES;" | mysql -u root

cd /var/lib/dokku/plugins
git clone https://github.com/rlaneve/dokku-link.git link
git clone https://github.com/jezdez/dokku-memcached-plugin memcached
git clone https://github.com/jezdez/dokku-postgres-plugin postgres
dokku plugins-install
Next to set up enviroment variables::

You can specify the buildpack you wish to use by creating a file name .env containing the following.
$ export DJANGO_SETTINGS_MODULE="config.local"
$ export DATABASE_URL="mysql://user:pass@localhost/feder"

.. code-block:: bash
Next to push migrations into database::

export BUILDPACK_URL=<repository>
$ python poradnia/manage.py migrate

You can then deploy by running the following commands.
You can now run the usual Django ``runserver`` command::

.. code-block:: bash
$ python poradnia/manage.py runserver

git remote add dokku dokku@yourservername.com:feder
git push dokku master
ssh -t dokku@yourservername.com dokku memcached:create feder-memcached
ssh -t dokku@yourservername.com dokku memcached:link feder-memcached feder
ssh -t dokku@yourservername.com dokku postgres:create feder-postgres
ssh -t dokku@yourservername.com dokku postgres:link feder-postgres feder
ssh -t dokku@yourservername.com dokku config:set feder DJANGO_SECRET_KEY=RANDOM_SECRET_KEY_HERE
ssh -t dokku@yourservername.com dokku config:set feder DJANGO_SETTINGS_MODULE='config.settings.production'
ssh -t dokku@yourservername.com dokku config:set feder DJANGO_AWS_ACCESS_KEY_ID=YOUR_AWS_ID_HERE
ssh -t dokku@yourservername.com dokku config:set feder DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY_HERE
ssh -t dokku@yourservername.com dokku config:set feder DJANGO_AWS_STORAGE_BUCKET_NAME=YOUR_AWS_S3_BUCKET_NAME_HERE
ssh -t dokku@yourservername.com dokku config:set feder DJANGO_MAILGUN_API_KEY=YOUR_MAILGUN_API_KEY
ssh -t dokku@yourservername.com dokku config:set feder DJANGO_MAILGUN_SERVER_NAME=YOUR_MAILGUN_SERVER
ssh -t dokku@yourservername.com dokku run feder python manage.py migrate
ssh -t dokku@yourservername.com dokku run feder python manage.py createsuperuser
To run tests use::

When deploying via Dokku make sure you backup your database in some fashion as it is NOT done automatically.
$ pip install -r requirements/test.txt
$ python manage.py test $@ -v2

0 comments on commit 60b3324

Please sign in to comment.