Skip to content

Commit

Permalink
Update CONTRIBUTING file removing references to old local config files
Browse files Browse the repository at this point in the history
  • Loading branch information
acelaya committed Oct 24, 2024
1 parent 9a58748 commit fc1f35a
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,20 @@ The first thing you need to do is fork the repository, and clone it in your loca

Then you will have to follow these steps:

* Copy all files with `.local.php.dist` extension from `config/autoload` by removing the dist extension.
* Copy the `config/params/shlink_dev_env.php.dist` in the same directory, but removing the `.dist` extension:

For example the `common.local.php.dist` file should be copied as `common.local.php`.
```
cp config/params/shlink_dev_env.php.dist config/params/shlink_dev_env.php
```
The `shlink_dev_env.php` file is gitignored, so you can customize it as you want. For example, by adding your own GeoLite license key.
* Do the same with the `docker-compose.override.yml.dist`:
```
cp docker-compose.override.yml.dist docker-compose.override.yml
```
* Copy the file `docker-compose.override.yml.dist` by also removing the `dist` extension.
* Start-up the project by running `docker compose up`.
The first time this command is run, it will create several containers that are used during development, so it may take some time.
Expand Down

0 comments on commit fc1f35a

Please sign in to comment.