From a1608b25b6560e4e546d16ba00d718143f099a8c Mon Sep 17 00:00:00 2001 From: divlo Date: Sun, 18 Apr 2021 02:11:33 +0200 Subject: [PATCH] docs(contributing): add Getting Started --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f09a76..36baefd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,3 +44,30 @@ Types define which kind of changes you made to the project. ### Scopes Scopes define what part of the code changed. + +## Getting Started + +### Installation + +```sh +# Clone the repository +git clone https://github.com/Divlo/Divlo.git + +# Go to the project root +cd Divlo + +# Configure environment variables +cp .env.example .env +``` + +### Development environment with [Docker](https://www.docker.com/) + +```sh +# Setup and run all the services for you +docker-compose up --build +``` + +### Services started + +- website : `http://localhost:3000` +- [MailDev](https://maildev.github.io/maildev/) : `http://localhost:1080`