search

getoutreach / epf

A framework for keeping your Ember.js apps in sync.
http://epf.io
MIT License
369 stars 33 forks source link

Documentation of expected JSON #116

Open gaker opened 10 years ago

gaker commented 10 years ago

I'm not a rails developer. As far as I can tell, EPF is made to work with ActiveModel::Serializer out of the box. It would be really nice if JSON examples were provided in the website documentation so one could structure their API to get up and running with EPF quickly.

Thanks in advance!

jerel commented 10 years ago

I would also love to see this.

ghempton commented 10 years ago

The documentation needs some serious overhaul. I will try and find time for this.

gaker commented 10 years ago

thanks @ghempton. If you can setup a base template or let us know where you'd like this kind of documentation to go, I'm happy to try to contribute to it as I get everything figured out. I'm working with django & django-rest-framework, so it requires a bit of wrangling of the output to match what epf expects.

Thanks so much for your work on epf, I really appreciate it.

ghempton commented 10 years ago

I am planning on overhauling the website soon, https://github.com/GroupTalent/epf-website will be where any such documentation will reside.