Contribs folder

In order to run a development version of pouet.net on your platform, you need to have a HTTP webserver, PHP and MySQL.

How to contribute ?

First thing, you need to fork it. Then you can start making changes on your fork. When done, you can create a pull request and people will review your change and test it on a staging version of the website. When your PR is ready to go live, a contributor will merge it into master and your proposed changes will automatically go live on Pouët in the next 5 minutes.

When is a new version deployed ?

Anytime a commit is pushed into the master branch, Pouët gets a call from Github and starts deploying a new version.

How can I push to `master` ?

You can't, only the maintainers can. If you want to see your code on the master branch, fork, commit, push, open a pull request, and wait for a maintainer to review, test and merge your pull request into master

Is the code tested before going live ?

Yes, maintainers have access to a staging version of pouet where they can push any local branch, the workflow for them is to test any code that is gonna be pushed to master before doing it for real.

Setup a dev environment

Quick HOWTO

Install an HTTP server, PHP and MySQL
Clone the pouet.net repository
Point the root directory of your HTTP server to the pouet.net source code, with PHP activated
In MySQL, create a pouet database, which can be accessed by a pouet user with a pouet password from localhost (see below)
Inject the sample data contribs/pouet_with_sample_data.sql in your MySQL server (see below)

Create the MySQL database and user

CREATE DATABASE 'pouet';
CREATE USER 'pouet'@'localhost' IDENTIFIED BY 'pouet';
GRANT ALL PRIVILEGES ON pouet.* TO 'pouet'@'localhost';

Inject the sample data

mysql -upouet -ppouet pouet < contribs/pouet_with_sample_data.sql

For more details, take a look at the instructions given for each platform below, they can help.

OS X

Clone the pouet.net repo, let's say it's now in /Users/you/src/pouet.net
Install MAMP, it's free
Launch it
In the preferences, on the Apache pane, put /Users/you/src/pouet.net as the document root
Start the servers

Now you need to create the pouet user and the pouet database in your newly installed MySQL server.

Run /Applications/MAMP/Library/bin/mysql -uroot -proot and execute the following SQL commands:

CREATE DATABASE 'pouet';
CREATE USER 'pouet'@'localhost' IDENTIFIED BY 'pouet';
GRANT ALL PRIVILEGES ON pouet.* TO 'pouet'@'localhost';

Once done, you test your MySQL user by doing:

/Applications/MAMP/Library/bin/mysql -upouet -ppouet pouet

I suggest you install Sequel Pro for all the MySQL stuff, it's free too !

Next, you want some starting data to play with, let's inject the copyleft data that's been given up to your by poueters:

/Applications/MAMP/Library/bin/mysql -upouet -ppouet pouet < /Users/you/src/pouet.net/contribs/pouet_with_sample_data.sql

Now you should be able to open your local pouet on http://localhost:8888/ !

Well done sir !

What about other platforms ?

Well, it's up to you to write the doc.

Fork, modify this file, and create your pull request !

3.4 KiB Raw Blame History