diff --git a/README.md b/README.md index e50413a90..416fcaefb 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ Logins: ## Directory Layout There are four important directories: + * [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 * [Cypress](./cypress) contains end-to-end tests and executable feature specifications @@ -46,16 +47,19 @@ There are two approaches: ## Installation ### Clone the Repository + Clone the repository, this will create a new folder called `Ocelot-Social`: Using HTTPS: + ```bash $ git clone https://github.com/Ocelot-Social-Community/Ocelot-Social.git ``` Using SSH: + ```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. @@ -88,13 +92,15 @@ docker-compose version 1.23.2 #### Start Ocelot-Social via Docker-Compose For Development: + ```bash -docker-compose up +$ docker-compose up ``` -For Production +For Production: + ```bash -docker-compose -f docker-compose.yml up +$ docker-compose -f docker-compose.yml up ``` This will start all required Docker containers @@ -131,4 +137,5 @@ Browser compatibility testing with [BrowserStack](https://www.browserstack.com/) BrowserStack Logo ## License + See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).