Skip to content

Commit

Permalink
Merge pull request #41 from CPNV-ES/feature/update-readme
Browse files Browse the repository at this point in the history
docs: Improve setup documentation
  • Loading branch information
Guillaume1868 authored Nov 22, 2024
2 parents c412b33 + 5a641ff commit 3da6180
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,20 @@ This is a project for the MAW11 course. We're supposed to rewrite [this website]
* Composer 2.7.8

### Configuration

Make `.env` file
and put the
```env
POSTGRES_USER=admin
POSTGRES_PASSWORD=mysecretpassword
[email protected]
PGADMIN_DEFAULT_PASSWORD=admin
```
or copy `.env.example`
Before starting the docker environment, you need to follow the following steps:
You need to setup the `.env` file.
Copy the `.env.example` file and change the environment variables content.

## Deployment

You need to install composer requirements :
`composer install`

Now you can start the docker stack.

If you want xdebug and phpmyadmin, use the dev environment. If you dont need them, use the production environment.


### On dev environment
#### Docker

Expand All @@ -39,12 +41,15 @@ docker-compose up
php -S localhost:8000 -t public
```

### On integration environment
### On prod environment

```bash
docker-compose -f docker-compose-prod.yml up
```

The application will be available at [127.0.0.1:8080](http://127.0.0.1:8080)


## Directory structure

```shell
Expand Down

0 comments on commit 3da6180

Please sign in to comment.