IT4Change/Ocelot-Social
3
0
Fork 0
mirror of https://github.com/IT4Change/Ocelot-Social.git synced 2025-12-13 07:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add section for directory layout

Browse Source
This commit is contained in:
Robert Schäfer 2019-04-14 14:03:54 +02:00
parent 1be334cef6
commit 51f0142e7f
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
installation.md
View File

@ -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.