Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/composer/packagist
Package Repository Website - try https://packagist.com if you need your own -
https://github.com/composer/packagist
packagist php
Last synced: about 18 hours ago
JSON representation
Package Repository Website - try https://packagist.com if you need your own -
- Host: GitHub
- URL: https://github.com/composer/packagist
- Owner: composer
- License: mit
- Created: 2011-06-09T20:50:15.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T10:12:23.000Z (15 days ago)
- Last Synced: 2025-01-15T23:05:17.923Z (15 days ago)
- Topics: packagist, php
- Language: PHP
- Homepage: https://packagist.org/
- Size: 11.8 MB
- Stars: 1,767
- Watchers: 80
- Forks: 475
- Open Issues: 71
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Packagist
Package Repository Website for Composer, see the
[about page](https://packagist.org/about) on
[packagist.org](https://packagist.org/) for more.
**This project is not meant for re-use.**
It is open source to make it easy to contribute. We provide no support
if you want to run your own, and will do breaking changes without notice.
Check out [Private Packagist](https://packagist.com/) if you want to
host your own packages.
## Development
These steps are provided for development purposes only.
### Requirements
- **PHP** for the web app
- **NPM** (or Docker) for the frontend build
- **[Symfony CLI](https://symfony.com/download)** 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
### Installation
1. Clone the repository
2. Install dependencies:
```bash
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`. Set also `MAILER_DSN` if you'd like 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.
### Fixtures
You can get test data by running the fixtures:
```bash
bin/console doctrine:fixtures:load --group base
bin/console doctrine:fixtures:load --group downloads --append
```
This will create some packages, update them from GitHub, populate them
with fake download stats, and assign a user named `dev` (with password: `dev`)
as their maintainer.
There is also a user `user` (with password: `user`) that has no access if you
need to check readonly views.
Finally there is a user `admin` (with password: `admin`) that has super admin
permissions.
### Search
To use the search in your local development environment, setup an
[Algolia Account](https://www.algolia.com/) and configure following keys
in your `.env.local`:
```dotenv
ALGOLIA_APP_ID=
ALGOLIA_ADMIN_KEY=
ALGOLIA_SEARCH_KEY=
ALGOLIA_INDEX_NAME=
```
To setup the search index, run:
```bash
bin/console algolia:configure
bin/console packagist:index
```