Repository files navigation

Package Repository Website for Composer, see theabout page onpackagist.org for more.

This project is not meant for re-use.

It is open source to make it easy to contribute. We provide no supportif you want to run your own, and will do breaking changes without notice.

Check outPrivate Packagist if you want tohost your own packages.

These steps are provided for development purposes only.

• PHP for the web app
• NPM (or Docker) for the frontend build
• Symfony CLI to run the web server
• MySQL (or Docker) for the main data store
• Redis (or Docker) for some functionality (favorites, download statistics)
• git / svn / hg depending on which repositories you want to support

1. Clone the repository

2. Install dependencies:

   composer installnpm install

   Ensure env vars are set up correctly, you probably need to setAPP_MAILER_FROM_EMAIL,APP_MAILER_FROM_NAME andAPP_DEV_EMAIL_RECIPIENT in.env.local. Set alsoMAILER_DSN if you'd like to receive email.

3. Start the web server:

   symfony serve -d

4. Start MySQL & Redis:

   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

   bin/console doctrine:database:createbin/console doctrine:database:create --env=test

6. Setup the database schema:

   bin/console doctrine:schema:create

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

8. Runnpm run build ornpm run dev to build (or build&watch) css/js files. When using Docker rundocker compose run node npm run dev to watch css/js files.

You should now be able to access the site, create a user, etc.

You can get test data by running the fixtures:

bin/console doctrine:fixtures:load --group basebin/console doctrine:fixtures:load --group downloads --append

This will create some packages, update them from GitHub, populate themwith fake download stats, and assign a user nameddev (with password:dev)as their maintainer.

There is also a useruser (with password:user) that has no access if youneed to check readonly views.

Finally there is a useradmin (with password:admin) that has super adminpermissions.

To use the search in your local development environment, setup anAlgolia Account and configure following keysin your.env.local:

ALGOLIA_APP_ID=ALGOLIA_ADMIN_KEY=ALGOLIA_SEARCH_KEY=ALGOLIA_INDEX_NAME=

To setup the search index, run:

bin/console algolia:configurebin/console packagist:index