ungleich-public/public-health-ch
6
1
Fork 0
Code Issues Pull requests 1 Projects Releases Wiki Activity

Expanded README with intro and production notes.

Browse source
This commit is contained in:
Oleg Lavrovsky 2017-04-25 15:59:42 +02:00
parent eb5b2a65a8
commit 584a085117
1 changed files with 45 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
README.md
View file

@ -1,22 +1,41 @@
Public Health Schweiz
=====================
Website of the Swiss Society for Public Health
New website of the [Swiss Society for Public Health](http://public-health.ch), developed by [Datalets](http://datalets.ch) using the open source, [Django](https://www.djangoproject.com/)-based [Wagtail CMS](http://wagtail.io). The frontend has been created using [Bootstrap](https://getbootstrap.com) framework.
## Development environment
The easiest way to set up your machine would be to use [Vagrant](https://vagrantup.com), then in the project folder in the terminal type:
The easiest way to set up your machine would be to use [Vagrant](https://vagrantup.com), then in the project folder in the terminal type: `vagrant liverun`.
To set up a full development environment, follow all these instructions.
**Frontend setup**
You will need to have Ruby and SASS installed on your system, e.g.:
```
vagrant liverun
sudo yum install rubygem-sass
```
Make sure a recent version of node.js (we recommend using [nave.sh](https://github.com/isaacs/nave)), then:
```
npm install -g bower grunt-cli
npm install
bower install
```
The first command (`..install -g..`) may require `sudo` if you installed node.js as a system package.
If you are only working on the frontend, you can start a local webserver and work on frontend assets without the backend setup described below. Mock content is at `publichealth/static/mockup`
**Backend setup**
After installing Python 3, from the project folder:
After installing Python 3, from the project folder, deploy system packages and create a virtual environment as detailed (for Ubuntu users) below:
```
sudo apt-get install python3-venv python3-dev libjpeg-dev
pyvenv env
. env/bin/activate
@ -29,26 +48,10 @@ pip install -r requirements.txt
You will be asked a few questions to create an administrator account.
**Frontend setup**
You will need to have Ruby and SASS installed on your system, e.g.:
```
sudo yum install rubygem-sass
```
Make sure a recent version of node.js, then:
```
npm install -g bower grunt-cli
npm install
bower install
```
**Starting up**
If you have one installed, also start your local redis server (`service redis start`).
**Starting up**
Run this after completing setup:
```
@ -66,8 +69,27 @@ Now access the admin panel with the user account you created earlier: http://loc
## Production notes
We use Ansible for automated deployment. You need to obtain an SSH and vault keys and place these in a `.keys` folder, then:
We use [Ansible](https://www.ansible.com) and [Docker Compose](https://docs.docker.com/compose/reference/overview/) for automated deployment.
You need to obtain SSH and vault keys, and place these in a `.keys` folder - then to deploy a site:
```
ansible-playbook -s ansible/docker.yaml -i ansible/inventories/production
ansible-playbook -s ansible/<*.yaml> -i ansible/inventories/production
```
We use a StackScript to deploy to Linode, the basic system set up is to have a user in the sudoers and docker group, and a few basic system packages ready.
For example, on Ubuntu:
```
apt-get install -q -y zip git nginx python-virtualenv python-dev
```
The order of deployment is:
- docker.yaml (base system)
- node.yaml
- site.yaml
- harden.yaml
For further deployment and system maintenance we have a `Makefile` which automates Docker Compose tasks.