Skip to content

Components for building a hypermedia-driven web apps powered by Linked Data

Notifications You must be signed in to change notification settings

hypermedia-app/creta-template-app

Repository files navigation

Creta Project Template

A copier template to bootstrap and maintain web applications built with creta

Prerequisites

  • Firstly, install pipx on your machine if you don't have it already. (docs for installing pipx)
  • Secondly, install Copier. The minimum required version for this template to work is v6.0.0b0 (reason why), installed from pipx
    • Run pipx install "copier==6.1.0" in your terminal
  • Thirdly, install Lando 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

Example

See in the ASCIIcasts below how to initialize a Creta TODOs project in creta-todos directory.

asciicast

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/

About

Components for building a hypermedia-driven web apps powered by Linked Data

Topics

Resources

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •