Documentation, development and deployment dependencies

almereyda commented 8 years ago

This branch includes commits which allow the API to run via Dokku. It is being achieved by

It is mergeable when the following features are present:

[ ] Deployment instructions for production and staging environments due to a request from @species
[x] Basic documentation of API endpoints, fixes #33
[ ] extend/rework the README to provide basic information about the API and its' intended purpose within the Transformap broader scope.

Further additions are:

a raw API endpoint that omits GeoJSON validation
Dokku/herokuish related repository layout
Improvements to the database initialization script passing generated configuration state We may still think of a way to mirror generated credentials external to stdout.
Docker Compose environments for production-like and development scenarios
a server patch to allow uploads of meaningful size
a missing dependency

gandhiano commented 8 years ago

I would propose adding a further requirement before getting this merged:

[ ] extend/rework the README to provide basic information about the API and its' intended purpose within the Transformap broader scope.

gandhiano commented 8 years ago

We are still missing basic API usage instructions, which makes it difficult to start using it. @almereyda could you commit to here and close the pull request? Or alternatively @species or @maxlath do it in another PR or directly?

species commented 7 years ago

As I want to get started to work on the API again, does it make sense to merge, even if documentation is not yet done 100%? I don't want to have big merge conflicts later...

almereyda commented 7 years ago

@species Yes, go ahead, as this is the currently live version, isn't it?

TransforMap / data.transformap.co

Documentation, development and deployment dependencies #34