Add documentation

[zemogle]

We don't even have any basic documentation. Some details of how you use the service would be useful.

[adrienbrunet]

Beside the fact that we could argue about mySql being mysql and not postgres 😆 , the requirements force us to have a mysql server up and running. We may want to include that in the installation docs. A simple pip install -r requirements.txt is not enough to start to help with the project. Maybe we could enable sqlite for dev puprpose only, it may help others to contribute. The hardest it is to setup, the hardest it is to have contributors..

It's always a pain in the arse to install mysql or postgres even if it's only a few command lines. I spend some time to make it run properly (I only use postgres for my others projects) and some guidelines would have been helpful.

[ire-and-curses]

We have a dev setting using sqlite on many of our other projects. I think it would be fine to do that here.

For what it's worth, I've never had a problem setting up mysql so I didn't realise this might be a hurdle. The package manager should do it for you on most Linux flavours. What were the biggest problems you faced? If you'd like to add some guidelines to the docs that would help future contributors, then that would be awesome!

[adrienbrunet]

Once you've done it once, it really easy. I tried that:

sudo apt-get install mysql-server php5-mysql libmysqlclient-dev
sudo mysql_install_db
pip install MySQL-python

It may not be the best and faster way but it seems to work.

[zemogle]

I like this idea. I was just trying to get an intern set up with a django project and Mysql was a stumbling block. I'm not sure the best way to handle this though, really we only need Mysql for the deployed version. Perhaps the settings.py doesn't need the mysql-python requirement if we include it in Dockerfile?

[adrienbrunet]

Indeed ... ! I'm not aware of particular requirements using mysql though.. Sometimes, it's easier to use the same db in dev and prod to avoid some deployment troubles.... I let you decide anyway ✌️