angular-seed icon indicating copy to clipboard operation
angular-seed copied to clipboard

Provide documentation for implied API endpoints

Open jvogtherr opened this issue 8 years ago • 2 comments

Hello,

Great work! I really like this project. I would wish for some documentation for the API endpoints that a server should have for this project (for example: /auth endpoint for login). Without guessing and trial-and-error implementation of the backend, you cannot really use this seed project quickly. Instead of providing a documentation, you could also provide a small implementation for this server for development (a small node.js implementation or python bottle or whatever).

Again, thank you for this project, Greetings

jvogtherr avatar Nov 14 '17 15:11 jvogtherr

Hi @jvogtherr I'm currently working on adding an api doc. Currently I have Postman API doc, Which shows how you can create an api for the seed.

For now you can update the local environment file to use this api. API_ENDPOINT: 'https://we-care-api.herokuapp.com/',

I'll be updating the code docs soon.

Thanks

pkrawat1 avatar Nov 15 '17 02:11 pkrawat1

Is any one working on Docs ?

vijayksingh avatar Jan 27 '18 16:01 vijayksingh