The future face of osu!.

Vagrant 1.7+ or equivalent development environment.

1. Clone repository
2. Open shell and point to checkout directory
3. cd vagrant; vagrant up
4. wait patiently
5. Access the site from http://localhost:8080/.

Note that you can get things running without vagrant. It should be pretty straightforward, but if you run into problems don't hesitate to open an issue asking for help!

c:\osuweb\vagrant> vagrant ssh
$ cd /data/osu\!web
$ hhvm artisan tinker
>>> App\Models\User::create(["username" => "yourusername", "user_password" => password_hash(md5("yourpassword"), PASSWORD_BCRYPT)]);

Using Laravel's Elixir.

c:\osu-web\vagrant> vagrant ssh
$ cd /data/osu\!web
$ hhvm artisan lang:js resources/assets/js/messages.js
$ ./node_modules/.bin/gulp

We welcome all contributions, but keep in mind that we already have the full site designed (mock-ups). If you wish to work on a new section, please open a ticket and we will give you what you need to proceed.

If you want to make changes to the design, we recommend you open an issue with your intentions before spending too much time, to ensure no effort is wasted.

Contributions can be made via pull requests to the repository. Please name your branch <your_github_username>/<your_change_description> for organisation purposes (ie. peppy/fix_user_display). We hope to credit and reward larger contributions, but cannot guarantee this (we'll do our best).

osu!web is licensed under AGPL version 3 or later. Please see the licence file for more information.