https://github.com/hypermedia-app/always-read-the-plaque
Starter pack for creating a Hydra API using Creta
https://github.com/hypermedia-app/always-read-the-plaque
Last synced: 10 days ago
JSON representation
Starter pack for creating a Hydra API using Creta
- Host: GitHub
- URL: https://github.com/hypermedia-app/always-read-the-plaque
- Owner: hypermedia-app
- License: mit
- Created: 2021-07-04T12:13:06.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-23T13:04:31.000Z (almost 5 years ago)
- Last Synced: 2025-01-04T03:12:35.484Z (over 1 year ago)
- Language: Shell
- Size: 311 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Always Read The Plaque
## [Hydra API][hydra] using [Creta][creta]
A minimal example of a Hypermedia API described using [Hydra Core vocabulary][hydra] and served with [Creta][creta].
It is inspired by the functionality of [99% Invisible](http://99pi.org) [project of the same name](https://readtheplaque.com).
## Running locally
1. [Install lando](https://docs.lando.dev/basics/installation.html)
2. `lando start`
3. `yarn bootstrap`
4. The API is running on [https://readtheplaque.lndo.site](https://readtheplaque.lndo.site)
5. Database is running on [http://db.readtheplaque.lndo.site/](http://db.readtheplaque.lndo.site/)
[creta]: https://creta.hypermedia.app
[hydra]: http://www.hydra-cg.com/spec/latest/core/