jamesplease / jamesplease/orbit-examples
Add docs about setting up JSON API server
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The [endpoints-example API](https://github.com/endpoints/endpoints-example) will serve as the API for the examples in this project. It's the quickest way I know of to get a JSON API-compliant API up and running.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Begin by reading the linked endpoints-example API and the existing examples in this repository; no documentation file is specified in the issue. Done means adding guidance that explains how to set up the server for this project's JSON API examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100