From 376b72ea35e3b8e3c6963e90611da6004731a2aa Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Mon, 2 Sep 2024 22:11:36 +0200 Subject: [PATCH] Tweak setup instructions a bit, refs #1457 --- .env | 2 +- README.md | 7 +++++++ config/parameters.yaml | 2 +- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.env b/.env index f6c8d5964..233b59601 100644 --- a/.env +++ b/.env @@ -20,7 +20,7 @@ APP_REMEMBER_ME_SECRET=${APP_SECRET} APP_HOSTNAME=packagist.lo APP_MAILER_FROM_EMAIL= APP_MAILER_FROM_NAME= -#APP_DEV_EMAIL_RECIPIENT=your-email@example.org +APP_DEV_EMAIL_RECIPIENT=your-email@example.org #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)$' diff --git a/README.md b/README.md index 3773709fd..9cab004c8 100644 --- a/README.md +++ b/README.md @@ -33,15 +33,19 @@ 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 @@ -49,11 +53,14 @@ These steps are provided for development purposes only. 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. diff --git a/config/parameters.yaml b/config/parameters.yaml index 3cb477f50..0d7ef4023 100644 --- a/config/parameters.yaml +++ b/config/parameters.yaml @@ -1,2 +1,2 @@ parameters: - fallback_gh_tokens: ['Seldaek'] + fallback_gh_tokens: []