This repository has been archived by the owner. It is now read-only.
Prototype of www.robotix.in built over DjangoCMS while utlilizing Zinnia as the blogging engine.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Robotix
config
docs
requirements
.coveragerc
.editorconfig
.gitattributes
.gitignore
.landscape.yml
.travis.yml
CONTRIBUTORS.txt
Gruntfile.js
LICENSE
Makefile
Procfile
README.rst
database.sql
install_os_dependencies.sh
install_python_dependencies.sh
manage.py
package.json
requirements.apt
requirements.txt
setup.cfg

README.rst

Robotix

The website for Robotix 2016

https://travis-ci.org/Robotix/Robotix.svg?branch=master Code Health https://coveralls.io/repos/Robotix/Robotix/badge.svg?style=flat Requirements Status

LICENSE: BSD

Settings

Robotix 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 'Robotix' environment variables to their Django setting:

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_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_EMAIL_BACKEND EMAIL_BACKEND django.core.mail.backends.console.EmailBackend django.core.mail.backends.smtp.EmailBackend
DJANGO_EMAIL_HOST EMAIL_HOST localhost smtp.sendgrid.com
EMAIL_PORT EMAIL_PORT 1025 587
SENDGRID_USERNAME EMAIL_HOST_USER n/a raises error
SENDGRID_PASSWORD EMAIL_HOST_PASSWORD n/a raises error
DJANGO_DEFAULT_FROM_EMAIL DEFAULT_FROM_EMAIL n/a "Robotix <noreply@robotix.in>"
EMAIL_SUBJECT_PREFIX EMAIL_SUBJECT_PREFIX n/a "[Robotix] "
  • TODO: Add vendor-added settings in another table

Getting up and contributing

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

  • Python 2.7.10
  • pip
  • virtualenv
  • PostgreSQL
  1. Fork the Robotix repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/Robotix.git
    
  3. Install Linux OS dependencies:

    $ sudo ./install_os_dependencies.sh install
    
  4. Install your local copy into a virtualenv__. This is how you set up your fork for local development:

    $ virtualenv .virtualenv --python=<path_to_python2.7.10>
    $ source ./.virtualenv/bin/activate
    $ ./install_python_dependencies.sh
    

Further help: http://stackoverflow.com/questions/5506110/is-it-possible-to-install-another-version-of-python-to-virtualenv

  1. Configure the DATABASE_URL environment variable:

    $ sudo -u postgres psql
    postgres=# ALTER USER postgres WITH PASSWORD 'robotix';
    postgres=# CREATE DATABASE robotix;
    postgres=# \q
    $ export DATABASE_URL='postgres://postgres:robotix@localhost:5432/robotix'
    

You can configure the DATABASE_URL to be exported every time the virtual environment is activated.:

$ echo export "DATABASE_URL='postgres://postgres:robotix@localhost:5432/robotix'" >> .virtualenv/bin/activate
  1. Import the database SQL dump into local database:

    $ make database
    
  2. Zinnia and its cmsplugin-zinnia have uncommited migrations that you may have to generate:

    $ python manage.py makemigrations
    
  3. To check whether the local development is correctly configured:

    $ python manage.py cms check
    
  4. You can now run the runserver_plus command:

    $ python manage.py runserver_plus
    

The base app will run but you'll need to carry out a few steps to make the sign-up and login forms work. These are currently detailed in issue #39.

  1. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature
    
  2. When you're done making changes, check that your changes pass flake8, pep8 and the tests:

    $ make lint
    $ make pep8
    $ make test
    
  3. Any change to the model structure must be proposed and discussed on the organization chat. If you change the model structue for any app, make sure you bundle the corresponding migrations in the same commit:

    $ python manage.py makemigrations
    
  4. If you introduce migrations or add intial data to applications, please rebuild the SQL file:

    $ make dump
    
  5. Commit your changes and push your branch to GitHub:

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    
  6. Submit a pull request through the GitHub website.

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 the included Grunt task.

Make sure that nodejs is installed. Then in the project root run:

$ npm install grunt

Now you just need:

$ 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

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:

heroku create --buildpack https://github.com/heroku/heroku-buildpack-python

heroku addons:create heroku-postgresql:dev
heroku pg:backups schedule DATABASE_URL
heroku pg:promote DATABASE_URL

heroku addons:create sendgrid:starter
heroku addons:create memcachier:dev

heroku config:set DJANGO_SECRET_KEY=RANDOM_SECRET_KEY_HERE
heroku config:set DJANGO_SETTINGS_MODULE='config.settings.production'

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 SENDGRID_USERNAME=YOUR_SENDGRID_USERNAME
heroku config:set SENDGRID_PASSWORD=YOUR_SENDGRID_PASSWORD

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.

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

You can specify the buildpack you wish to use by creating a file name .env containing the following.

export BUILDPACK_URL=<repository>

You can then deploy by running the following commands.

git remote add dokku dokku@yourservername.com:Robotix
git push dokku master
ssh -t dokku@yourservername.com dokku memcached:create Robotix-memcached
ssh -t dokku@yourservername.com dokku memcached:link Robotix-memcached Robotix
ssh -t dokku@yourservername.com dokku postgres:create Robotix-postgres
ssh -t dokku@yourservername.com dokku postgres:link Robotix-postgres Robotix
ssh -t dokku@yourservername.com dokku config:set Robotix DJANGO_SECRET_KEY=RANDOM_SECRET_KEY_HERE
ssh -t dokku@yourservername.com dokku config:set Robotix DJANGO_SETTINGS_MODULE='config.settings.production'
ssh -t dokku@yourservername.com dokku config:set Robotix DJANGO_AWS_ACCESS_KEY_ID=YOUR_AWS_ID_HERE
ssh -t dokku@yourservername.com dokku config:set Robotix DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY_HERE
ssh -t dokku@yourservername.com dokku config:set Robotix DJANGO_AWS_STORAGE_BUCKET_NAME=YOUR_AWS_S3_BUCKET_NAME_HERE
ssh -t dokku@yourservername.com dokku config:set Robotix SENDGRID_USERNAME=YOUR_SENDGRID_USERNAME
ssh -t dokku@yourservername.com dokku config:set Robotix SENDGRID_PASSWORD=YOUR_SENDGRID_PASSWORD
ssh -t dokku@yourservername.com dokku run Robotix python manage.py migrate
ssh -t dokku@yourservername.com dokku run Robotix python manage.py createsuperuser

When deploying via Dokku make sure you backup your database in some fashion as it is NOT done automatically.