Skeleton

Project for Frank applications deployed by JAR or Docker

• Skeleton Project for Frank applications deployed by JAR or Docker
  • Introduction
  • Included
  • Usage
    • Steps
    • Template variables

Introduction

This project serves as a starting point for new projects or as example for existing ones. This "empty" Frank! will have configuration files to build and deploy.

Included

• Dockerfile
• Docker compose
• Publicode (WIP)
• GitHub Actions
  • Release
  • Docker build & upload

Please check if you deem all these functionalities necessary, if not remove them.

Usage

Steps

1. Clone or download this project
2. Find-and-replace the template variables listed in the [template variables](#Template variables) section
3. Add your own configuration files
4. Make sure that the GitHub action credentials are added
5. Commit & Profit!

Template variables

Template variable	Description	Example
%%INSTACE_NAME%%	The name of the Frank! to be deployed. It's best to keep this inline with the name of the repo	Frank2Skeleton
%%INSTANCE_NAME_LOWERCASE%%	Lowercase version of the instance name.	frank2example
%%CONFIGURATION_NAME%%	The name of the first configuration (others have to be added manually)	Sans