Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide documentation for implied API endpoints #1

Open
jvogtherr opened this issue Nov 14, 2017 · 2 comments
Open

Provide documentation for implied API endpoints #1

jvogtherr opened this issue Nov 14, 2017 · 2 comments
Assignees

Comments

@jvogtherr
Copy link

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

@pkrawat1
Copy link
Member

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 pkrawat1 self-assigned this Nov 15, 2017
@vijayksingh
Copy link

Is any one working on Docs ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants