From 024cf6c1d8d2c1b10e5014e50722931d518373d5 Mon Sep 17 00:00:00 2001 From: Frederik Ring Date: Sat, 2 Sep 2023 21:24:36 +0200 Subject: [PATCH] Add basic README --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1fd62cb..bdd6778 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -# website + + Offen logo + + +# Website + +## The www.offen.software website + +This repository contains the source code for the website. + +--- + +### Developing the application + +The development setup requires `docker` and `docker compose` to be installed. + +After cloning the repository, you can build the containers and install dependencies using: + +```sh +$ make setup +``` + +You can test your setup by starting the application: + +```sh +$ make up +``` + +which should enable you to access the homepage at .