|
|
@@ -3,24 +3,43 @@ 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 but 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.
|
|
|
+**This project is not meant for re-use.**
|
|
|
|
|
|
-Requirements
|
|
|
-------------
|
|
|
+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.
|
|
|
|
|
|
-- MySQL for the main data store
|
|
|
-- Redis for some functionality (favorites, download statistics)
|
|
|
-- git/svn/hg depending on which repositories you want to support
|
|
|
+Check out [Private Packagist](https://packagist.com/) if you want to host your own packages.
|
|
|
|
|
|
-Installation
|
|
|
+Development
|
|
|
------------
|
|
|
|
|
|
+These steps are provided for development purposes only.
|
|
|
+
|
|
|
+### Requirements
|
|
|
+
|
|
|
+- **PHP** for the web app
|
|
|
+- **[Symfony CLI](https://symfony.com/download)** to run the web server
|
|
|
+- **MySQL** for the main data store
|
|
|
+- **Redis** for some functionality (favorites, download statistics)
|
|
|
+- **git / svn / hg** depending on which repositories you want to support
|
|
|
+
|
|
|
+### Installation
|
|
|
+
|
|
|
1. Clone the repository
|
|
|
-2. Edit `app/config/parameters.yml` and change the relevant values for your setup.
|
|
|
-3. Install dependencies: `php composer.phar install`
|
|
|
-4. Run `app/console doctrine:schema:create` to setup the DB
|
|
|
-5. Run `app/console assets:install web` to deploy the assets on the web dir.
|
|
|
-6. Run `app/console cache:warmup --env=prod` and `app/console cache:warmup --env=prod` to warmup cache
|
|
|
-7. Make a VirtualHost with DocumentRoot pointing to web/
|
|
|
+2. Create 2 databases:
|
|
|
+ - `packagist` - for the web app
|
|
|
+ - `packagist_test` - for running the tests
|
|
|
+3. Install dependencies:
|
|
|
+ ```bash
|
|
|
+ composer install
|
|
|
+ ```
|
|
|
+ The composer install will prompt you for the database connection details on first install.
|
|
|
+4. Setup the database:
|
|
|
+ ```bash
|
|
|
+ app/console doctrine:schema:create
|
|
|
+ ```
|
|
|
+5. Start the web server:
|
|
|
+ ```bash
|
|
|
+ symfony serve
|
|
|
+ ```
|
|
|
|
|
|
You should now be able to access the site, create a user, etc.
|
Jack Bentley