https://github.com/hypermedia-app/creta-template-app
Components for building a hypermedia-driven web apps powered by Linked Data
https://github.com/hypermedia-app/creta-template-app
copier-template
Last synced: 8 months ago
JSON representation
Components for building a hypermedia-driven web apps powered by Linked Data
- Host: GitHub
- URL: https://github.com/hypermedia-app/creta-template-app
- Owner: hypermedia-app
- Created: 2021-12-21T20:52:19.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-17T08:00:41.000Z (over 2 years ago)
- Last Synced: 2025-01-04T03:12:33.722Z (10 months ago)
- Topics: copier-template
- Language: Jinja
- Homepage:
- Size: 394 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Creta Project Template
A [copier](https://github.com/copier-org/copier/#readme) template to bootstrap and maintain web applications built with [creta](https://creta.hypermedia.app/)
## Prerequisites
- Firstly, install pipx on your machine if you don't have it already. _([docs for installing pipx](https://github.com/pypa/pipx#install-pipx))_
- Secondly, install Copier. The minimum required version for this template to work is `v6.0.0b0` (_reason [why](https://github.com/copier-org/copier/discussions/639)_), installed from `pipx`
- Run `pipx install "copier==6.1.0"` in your terminal
- Thirdly, [install Lando](https://github.com/lando/lando/releases) to be able to run a local dockerized environment
## Usage
Use this template to initialize a new project:
- `copier -a .copier-creta.yaml gh:hypermedia-app/creta-project-template.git {{project-name}}`
- creates a base project structure in the give directory
- `cd {{project-name}}`
- `yarn`
- `git add -A; git commit -m"init project"`
Then, start by running `lando start`
Finally, running the command `yarn bootstrap` will populate the database with the minimal resources
## What you get
Depending on the exact answers given to `copier`:
1. Monorepo with one or more APIs
2. A front end application
3. Fully functional local environment
- express app serving the API(s)
- a front end application
- [AllegroGraph](https://allegrograph.com/) triplestore
- Configured [Zazuko Graph Explorer](https://github.com/zazuko/graph-explorer)
- Local SPARQL UI running [Zazuko trifid](https://zazuko.com/products/trifid/)
## Example
See in the ASCIIcasts below how to initialize a `Creta TODOs` project in `creta-todos` directory.
[](https://asciinema.org/a/RCToq4LcB6YhmKTpS2ILddvsg)
This will start all the necessary services, accessible on a local domain (HTTPS included):
| Service | Local address |
| -- | -- |
| Web application | https://creta-todos.lndo.site/app |
| TODOs API | https://creta-todos.lndo.site/todos |
| Users API | https://creta-todos.lndo.site/users |
| Database | http://db.creta-todos.lndo.site/ |
| Trifid UI | http://trifid.creta-todos.lndo.site/sparql |
| Graph Explorer | http://explore.creta-todos.lndo.site/ |