Eau de web - README.rst template

README.rst

[PROJECT_NAME] =====

Project Name

The Project Name is [PROJECT_NAME] [PROJECT_URL]

Prerequisites - System packages

These packages should be installed as superuser (root).

Debian based systems

Install these before setting up an environment:

apt-get install python-setuptools python-dev libmysqlclient-dev \
libldap2-dev python-virtualenv mysql-server git

RHEL based systems

Install Python2.7 with PUIAS: https://gist.github.com/nico4/9616638

Run these commands:

curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python2.7 -
pip2.7 install virtualenv
yum install mysql-server mysql git openldap-devel mysql-devel

Product directory

TODO

Install dependencies

We should use Virtualenv for isolated environments. The following commands will be run as an unprivileged user in the product directory:

1. Clone the repository:

   git clone [GITHUB_SSH] -o origin [PROJECT_ORIGIN]
   cd [PROJECT_ORIGIN]

2. Create & activate a virtual environment:

   virtualenv --no-site-packages sandbox
   echo '*' > sandbox/.gitignore
   source sandbox/bin/activate

3. Make sure setuptools >= 0.8 is installed:

   pip install -U setuptools

4. Install dependencies:

   pip install -r requirements.txt

5. Create a configuration file:

   mkdir -p instance
   cp settings.py.example instance/settings.py
   
   # Follow instructions in instance/settings.py to adapt it to your needs.

6. Set up the MySQL database:

   TODO

7. Import possible sql dump into database, see "data import" below:

   TODO

8. Create possible your user and assign admin role to it:

   TODO

Build production

Setup the production environment like this (using an unprivileged user):

TODO

Configure supervisord and set the WSGI server port (by default it is 5000):

TODO

At this stage, the application is up and running. You should also configure:

TODO

Build staging

TODO

Configuration

Details about configurable settings can be found in settings.py.example.

TODO

Data Import

TODO

Development hints

Requirements

TODO

Configure deploy

TODO

Running unit tests

TODO

Contacts

The project owner is Søren Roug (soren.roug at eaa.europa.eu)

Other people involved in this project are:

• Cornel NiÈ›u (cornel.nitu at eaudeweb.ro)
• Alex Eftimie (alex.eftimie at eaudeweb.ro)
• ...

Resources

Hardware

Minimum requirements:

• 2048MB RAM
• 2 CPU 1.8GHz or faster
• 4GB hard disk space

Recommended:

• 4096MB RAM
• 4 CPU 2.4GHz or faster
• 8GB hard disk space

Software

Any recent Linux version. apache2, local MySQL server

Copyright and license

This project is free software; you can redistribute it and/or modify it under the terms of the EUPL v1.1.

More details under LICENSE.txt.

TODO