spaceapi.io
- Dominant language
- JavaScript
- Stars
- 27.2k
- Forks
- 5.6k
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 46
Description
:clipboard: **Description**
:link: **Data**
This badge should show whether a hackerspace using the https://spaceapi.io
is open or closed.
Data can be retrieved from two kinds of endpoints:
1. The spaceapi directory
- JSON: https://directory.spaceapi.io/
- documentation: https://github.com/SpaceApi/directory/issues/166
This will be used to retrieve the url of the endpoint (2).
`/spaceapi/state/name/:hackerspaceid` e.g. `/spaceapi/state/AFRA`
2. The endpoint
e.g. https://spaceapi.afra-berlin.de/v1/status.json
`/spaceapi/state/url/:apiurl`


:microphone: **Motivation**
I would like to be able to show a badge that displays whether my hackerspace is open.
Contributor guide
Research direction
Start by reading the SpaceAPI directory documentation linked in the issue and reviewing existing Shields badge implementations. Trace how the directory lookup and the returned endpoint would provide the hackerspace state. Done means a badge can display the space name with distinct open and closed states using the documented endpoints.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100