From 51f0142e7f9823b0990e750e085bcc6700d4f627 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Sch=C3=A4fer?= Date: Sun, 14 Apr 2019 14:03:54 +0200 Subject: [PATCH] Add section for directory layout --- installation.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/installation.md b/installation.md index 9686dfc45..341dd429d 100644 --- a/installation.md +++ b/installation.md @@ -1,17 +1,12 @@ # Installation -## General Install Instructions - The repository can be found on GitHub. [https://github.com/Human-Connection/Human-Connection](https://github.com/Human-Connection/Human-Connection) -{% hint style="info" %} -TODO: Create documentation section for How to Start and Beginners. -{% endhint %} - We give write permissions to every developer who asks for it. Just text us on [Discord](https://discord.gg/6ub73U3). -#### Clone the Repository +## Clone the Repository + Clone the repository, this will create a new folder called `Human-Connection`: @@ -35,6 +30,18 @@ Change into the new folder. $ cd Human-Connection ``` +## Directory Layout + +There are four important directories: +* [Backend](./backend) runs on the server and serves as a middleware to the database +* [Frontend](./webapp) server-side and client-side rendered application +* [Deployment](./deployment) contains configuration for kubernetes deployments +* [Cypress](./cypress) end-to-end tests with cypress + +In order to setup the application you have to setup the frontend and backend +either locally on your system or you can also use our provided docker +installation. + ## Docker Installation Docker is a software development container tool that combines software and its dependencies into one standardized unit that contains everything needed to run it. This helps us to avoid problems with dependencies and makes installation easier.