1
1
mirror of https://github.com/theoludwig/theoludwig.git synced 2024-12-08 00:44:30 +01:00

docs(contributing): add Getting Started

This commit is contained in:
divlo 2021-04-18 02:11:33 +02:00
parent c2f762ac68
commit a1608b25b6

View File

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