santropolroulant / volunteerdb

MIT License
1 stars 0 forks source link

Document installation #2

Open kousu opened 6 years ago

kousu commented 6 years ago

There should be documentation on how to get this project up and running from scratch, in either dev or production. The readme right now is the default CakePHP readme from 6 years ago.

kousu commented 6 years ago

I've done most of this just now on the master branch, though it's not finished.

kousu commented 6 years ago

Related: #10

kousu commented 6 years ago

The install docs are done. The only thing that's not up to snuff is the docker instructions, but we have #22 for that.

kousu commented 6 years ago

The dev setup docs are misleading, maybe outright wrong.

Setting this up on Linux is fairly straightforward (and that is what we are deploying on, too), but OS X is not, because you need to install and configure the PHP and MySQL/postgres from brew.

It would help to have subsections for Linux/OS X/Windows.