Skip to content

Commit

Permalink
Adjust contribution docs to use docker compose exec instead of docker…
Browse files Browse the repository at this point in the history
… run
  • Loading branch information
Kovah committed May 2, 2024
1 parent d05686d commit e4b3da9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ The following steps assume that you are using Docker or Podman for development,

```bash
cp .env.docker .env
docker-compose up -d --build
docker compose up -d --build
```

Now, install all dependencies from inside the PHP container:

```bash
docker exec -it linkace-php composer install
docker compose exec -it php composer install

docker exec -it linkace-php php artisan key:generate
docker compose exec -it php php artisan key:generate
```

Last step: compile all assets. Node 16 LTS is the minimum version required and recommended to use. You may use either NPM or Yarn for installing the asset dependencies.
Expand All @@ -58,15 +58,15 @@ npm run dev
I recommend using the Artisan command line tool in the PHP container only, to make sure that the same environment is used. To do so, use the following example command:

```bash
docker exec -it linkace-php php artisan migrate
docker compose exec -it php php artisan migrate
```

#### 3. Registering a new user

Currently, you can do this by using the command line:

```bash
docker exec -it linkace-php php artisan registeruser [user name] [user email]
docker compose exec -it php php artisan registeruser [user name] [user email]
```


Expand All @@ -75,8 +75,8 @@ docker exec -it linkace-php php artisan registeruser [user name] [user email]
You can run existing tests with the following command:

```bash
docker exec -it linkace-php composer run lint
docker exec -it linkace-php composer run test
docker compose exec -it php composer run lint
docker compose exec -it php composer run test
```


Expand Down
1 change: 0 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ services:

# --- PHP
php:
container_name: linkace-php
build:
context: .
dockerfile: ./resources/docker/dockerfiles/development.Dockerfile
Expand Down

0 comments on commit e4b3da9

Please sign in to comment.