mirror of
https://github.com/Poniverse/Pony.fm.git
synced 2024-11-22 04:58:01 +01:00
9d0b2e598d
Also tweaked formatting in a few places and changed the IP address for the dev environment's database to the hostname.
82 lines
3.5 KiB
Markdown
82 lines
3.5 KiB
Markdown
[](https://pony.fm/)
|
|
|
|
The community for pony fan music.
|
|
|
|
For artists, Pony.fm features unlimited uploads and downloads, automatic
|
|
transcoding to a number of audio formats, and synchronized tags in all
|
|
downloads.
|
|
|
|
For listeners, Pony.fm offers unlimited streaming and downloading, user-generated
|
|
playlists, favourite lists, and a way of discovering new music with pony-based
|
|
taxonomies.
|
|
|
|
|
|
Contributing
|
|
------------
|
|
If you've run across a bug or have a feature request,
|
|
[open an issue](https://github.com/Poniverse/Pony.fm/issues/new)
|
|
for it.
|
|
|
|
For general questions and discussions about the site, stop by at
|
|
the [Pony.fm forum](https://mlpforums.com/forum/62-ponyfm/).
|
|
|
|
For quick fixes, go ahead and submit a pull request!
|
|
|
|
For larger features, it's best to open an issue before sinking a ton of work
|
|
into building them, to coordinate with Pony.fm's maintainers.
|
|
|
|
**Protip:** Looking for a place to jump in and start coding? Try a
|
|
[quickwin issue](https://github.com/Poniverse/Pony.fm/labels/quickwin%21) -
|
|
these are smaller in scope and easier to tackle if you're unfamiliar with the codebase!
|
|
|
|
|
|
Starting a dev environment
|
|
==========================
|
|
|
|
To begin development, you must do three things:
|
|
|
|
1. Install the `vagrant-hostmanager` plugin: `vagrant plugin install vagrant-hostmanager`
|
|
|
|
2. Install the `vagrant-bindfs` plugin: `vagrant plugin install vagrant-bindfs`
|
|
|
|
3. Create the directory `pony.fm.files` in the repository's parent directory
|
|
|
|
4. Run `vagrant up` from the folder in which you cloned the repository
|
|
|
|
5. Run `vagrant ssh`, `cd /vagrant`, and `php artisan poni:setup`.
|
|
|
|
6. Follow the instructions in the "Asset pipeline" section below to set that up.
|
|
|
|
Once everything is up and running, you'll be able to access the site at [http://ponyfm-dev.poni/](http://ponyfm-dev.poni/). You can access the MySQL database by logging into **ponyfm-dev.poni:3306** with the username **homestead** and the password **secret**. Pony.fm's database is named **homestead**.
|
|
|
|
Asset pipeline
|
|
--------------
|
|
|
|
Pony.fm uses [gulp](http://gulpjs.com/) to mange its asset pipeline.
|
|
|
|
**Important:** Run `npm` and `gulp` from your host machine and not within the VM. You must first have it installed globally:
|
|
|
|
npm install -g gulp
|
|
|
|
And then install all of the required local packages by invoking:
|
|
|
|
npm install
|
|
|
|
Finally, build all of the scripts by executing:
|
|
|
|
gulp build
|
|
|
|
During development, you should make a point to run "gulp watch". You can do this simply by executing:
|
|
|
|
gulp watch
|
|
|
|
This will watch and compile the `.less` and `.coffee` files in real time.
|
|
|
|
Configuring the servers
|
|
-----------------------
|
|
|
|
Pony.fm uses nginx, php-fpm, redis, and MySQL. You can modify the configuration of these services by locating the appropriate config file in the `vagrant` folder. Once modified, you must reload the configuration by running the appropriate shell script (`reload-config.sh`) or bat files (`reload-config.bat` and `reload-config.vmware.bat`). These scripts simply tell Vagrant to run `copy-and-restart-config.sh` on the VM.
|
|
|
|
If you need to change any other configuration file on the VM - copy the entire file over into the vagrant folder, make your changes, and update the `copy-and-restart-config.sh` script to copy the modified config back into the proper folder. All potential configuration requirements should be represented in the `vagrant` folder **and never only on the VM itself** as changes will not be preserved.
|
|
|
|
**NOTE:** currently, Redis's configuration is not reloaded by the `copy-and-restart-config.sh`
|