Skip to content

Commit

Permalink
Tweak setup instructions a bit, refs #1457
Browse files Browse the repository at this point in the history
  • Loading branch information
Seldaek committed Sep 2, 2024
1 parent 29ce8c5 commit 376b72e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ APP_REMEMBER_ME_SECRET=${APP_SECRET}
APP_HOSTNAME=packagist.lo
APP_MAILER_FROM_EMAIL=
APP_MAILER_FROM_NAME=
#[email protected]
APP_DEV_EMAIL_RECIPIENT=[email protected]
#TRUSTED_PROXIES=127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
#TRUSTED_HOSTS='^(localhost|example\.com)$'

Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,34 @@ These steps are provided for development purposes only.
composer install
npm install
```
Ensure env vars are set up correctly, you probably need to set `APP_MAILER_FROM_EMAIL`, `APP_MAILER_FROM_NAME` and `APP_DEV_EMAIL_RECIPIENT` in .env.local and possibly `MAILER_DSN` if you need to receive email.

3. Start the web server:
```bash
symfony serve -d
```

4. Start MySQL & Redis:
```bash
docker compose up -d # or somehow run MySQL & Redis on localhost without Docker
```
This mounts the current working directory into the node container and runs npm install and npm run build automatically.

5. Create 2 databases:
- `packagist` - for the web app
- `packagist_test` - for running the tests
```bash
bin/console doctrine:database:create
bin/console doctrine:database:create --env=test
```

6. Setup the database schema:
```bash
bin/console doctrine:schema:create
```

7. Run a CRON job `bin/console packagist:run-workers` to make sure packages update.

8. Run `npm run build` or `npm run dev` to build (or build&watch) css/js files. When using Docker run `docker compose run node npm run dev` to watch css/js files.

You should now be able to access the site, create a user, etc.
Expand Down
2 changes: 1 addition & 1 deletion config/parameters.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
parameters:
fallback_gh_tokens: ['Seldaek']
fallback_gh_tokens: []

0 comments on commit 376b72e

Please sign in to comment.