ocelot-Social-Community/Ocelot-Social
1
0
Fork 0
mirror of https://github.com/Ocelot-Social-Community/Ocelot-Social.git synced 2025-12-13 07:46:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor some HC and prettify some formating

Browse Source
This commit is contained in:
Wolfgang Huß 2021-05-31 18:07:52 +02:00
parent b824ebb9f5
commit 36de9a3451
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -31,6 +31,7 @@ Logins:
## Directory Layout ## Directory Layout
There are four important directories: There are four important directories:
* [Backend](./backend) runs on the server and is a middleware between database and frontend * [Backend](./backend) runs on the server and is a middleware between database and frontend
* [Frontend](./webapp) is a server-side-rendered and client-side-rendered web frontend * [Frontend](./webapp) is a server-side-rendered and client-side-rendered web frontend
* [Cypress](./cypress) contains end-to-end tests and executable feature specifications * [Cypress](./cypress) contains end-to-end tests and executable feature specifications
@ -46,16 +47,19 @@ There are two approaches:
## Installation ## Installation
### Clone the Repository ### Clone the Repository
Clone the repository, this will create a new folder called `Ocelot-Social`: Clone the repository, this will create a new folder called `Ocelot-Social`:
Using HTTPS: Using HTTPS:
```bash ```bash
$ git clone https://github.com/Ocelot-Social-Community/Ocelot-Social.git $ git clone https://github.com/Ocelot-Social-Community/Ocelot-Social.git
``` ```
Using SSH: Using SSH:
```bash ```bash
$ git clone git@github.com:Human-Connection/Human-Connection.git $ git clone git@github.com:Ocelot-Social-Community/Ocelot-Social.git
``` ```
Change into the new folder. Change into the new folder.
@ -88,13 +92,15 @@ docker-compose version 1.23.2
#### Start Ocelot-Social via Docker-Compose #### Start Ocelot-Social via Docker-Compose
For Development: For Development:
```bash ```bash
docker-compose up $ docker-compose up
``` ```
For Production For Production:
```bash ```bash
docker-compose -f docker-compose.yml up $ docker-compose -f docker-compose.yml up
``` ```
This will start all required Docker containers This will start all required Docker containers
@ -131,4 +137,5 @@ Browser compatibility testing with [BrowserStack](https://www.browserstack.com/)
<img alt="BrowserStack Logo" src=".gitbook/assets/browserstack-logo.svg" width="256"> <img alt="BrowserStack Logo" src=".gitbook/assets/browserstack-logo.svg" width="256">
## License ## License
See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT). See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).