The CASH Music Platform is very much still a work in progress in its pre-release lifecycle.
The DIY version of the CASH platform is a locally-installable framework intended to work in a request/response model similar to a REST implementation and handle complex functionality around the marketing, promotion, and sale of music on an artist's site. It is designed to work as a freestanding API or integrated with publishing and CMS systems like Wordpress or Drupal.
One of the fundamental goals of CASH Music is the be as widely deployable as possible, and hence, to have extremely minimal dependencies outside of what comes bundled. Current requirements:
- PHP 5.2.7
- PDO
- MySQL or SQLite. Other databases could be supported if needed.
- mod_rewrite (for admin)
- fopen wrappers OR cURL (either, for fetching external feeds)
To get your hands on a working instance as quickly as possible, fork/clone this repo and once it's local run /installers/php/dev_installer.php from the command
php path/to/DIY//installers/php/dev_installer.phpchoose the SQLite install option and supply an email for the admin login. Next just point Apache or MAMP at the main repo directory and view http://localhost/ in a browser.
We've included a web installer specifically meant for installing the CASH platform to a remote host. To use, simply download it here, FTP to your web host, create a folder for it, and visit in a web browser. The installer will do the rest.
Most of the code is currently found in framework/php/ and centers around a single-include workflow, which means the only thing you need to do to add CASH to your site/page is include this single file:
// this loads CASH Music DIY
$CASHMUSIC = "/home/billybob/cashmusic";
require_once("$CASHMUSIC/framework/php/cashmusic.php");
where the $CASHMUSIC variable is the directory where you installed CASH Music on your server.
To hack on CASH Music DIY, first grab the git repo:
git clone git://github.com/cashmusic/DIY.git
If you are behind a pesky firewall, you might need to use https, but only do this if you must, since it is much slower and uses up more bandwidth:
git clone https://[email protected]/cashmusic/DIY.git
Read the test suite https://github.com/cashmusic/DIY/blob/master/tests/README.md
We try to keep the 'master' branch release-ready at all times, but it is the first place new changes are merged into — be aware that it will break from time to time.
We work on specific features in feature branches named for the feature, for example: 'feature_browserid' or similar.
Contributors are asked to fork, create a branch, and submit pull requests to 'master.'
The 'latest_stable' branch will always point to the most recent public release.
We highly encourage everybody to scratch their itch and contribute back to CASH Music.
We prefer Github pull requests, but we will take contributions any way we can get them. If you need to etch a patch on a grain of rice, please send a magnifying glass.
We assume that you already have a free Github account. If you don't already, do that now. We promise, it is the bees knees.
First, you will want to create your "fork" of CASH Music DIY. To do this, go to the CASH Music DIY Github project and click on the grey "Fork" button on the top right. You should see a note about "Hardcore Forking Action" happening (teehee) and then the page will reload so you can look at your spiffy new fork!
Next, click the little button next to "Read+Write access" just above the the box describing the latest commit. That will copy the URL of your fork to your clipboard.
# replace USERNAME with your github username (or just paste the URL you just copied above)
git clone [email protected]:USERNAME/DIY.git
cd DIY
# change to the latest_stable branch
git checkout latest_stable
# create a new topic branch
git checkout -b my_cool_feature_branch
At this point, you actually hack on code, fix some docs, make something better, whatever. When you get to a stopping point, add the files that you have changed or added:
git add new_file.php changed_file.php
And then commit with a useful commit message:
git commit -m "I promise that awesome new feature X will not set your dog on fire"
Commit early and often. It is like brushing your teeth: You can't do it too much. When you are ready to send your changes up to your fork on the Github mothership:
git push origin my_cool_feature_branch
Now you will be able to get feedback on your code, submit pull requests and generally bask in the glory of social coding.
We use something called Jitterbug to run our tests every time someone pushes to the CASH Music DIY Github repo. You can see the results of each test run here .
PHP may not have SQLite support. We work around PHP's native SQLite implementation by going through the PDO object for all queries — which allows SQLite3 support in PHP 5.2. This is still dependent on the underlying system supporting SQLite, and in some instances it will not be available.
Separate schemas are maintained for SQLite and MySQL out of necessity.
CASH Music DIY is (c) 2010-2012 CASH Music
Licensed under the AGPL license