Skip to content
the browser-facing portion of osu!
Branch: master
Clone or download
Latest commit 9a1fd31 Jul 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.docker Move docker user $HOME Oct 15, 2018
app Merge branch 'master' into dont-fail-on-missing-updatestream Jul 3, 2019
bin works without run Apr 17, 2019
bootstrap Works with test and stuff. Nov 28, 2017
config Merge branch 'master' into feature/search-previous-username Jun 26, 2019
database Save last sort option Jun 25, 2019
docker Merge branch 'master' into feature/docker-node-alpine-git Jun 11, 2019
docs Link notification names May 29, 2019
public Merge branch 'master' into update-store-header Jun 20, 2019
resources Merge branch 'master' into user-settings Jul 3, 2019
routes Merge branch 'master' into user-settings Jul 3, 2019
storage Update to latest clockwork Aug 1, 2018
tests Merge branch 'master' into user-settings Jul 3, 2019
.editorconfig Default indenting to 2 spaces for everything and override to 4 for ph… Jun 20, 2018
.env.dusk.local.example Add example .env.dusk.local file Feb 14, 2019
.env.example Move notification jobs back to main redis Apr 18, 2019
.gitattributes Enforce lf for sh files Aug 17, 2016
.gitignore Ignore all env except examples Apr 15, 2019
.styleci.yml Disable styleci phpdoc fixer May 23, 2019
.travis.yml probably can skip more things Jun 7, 2019
CONTRIBUTING.md Move code style sections to CONTRIBUTING.md Jun 1, 2018
LICENCE Fix wording in licence Nov 2, 2015
README.md Update contribution section of readme in line with bounty changes Jul 3, 2019
SETUP.md override migrate:fresh command Jun 12, 2019
artisan Laravel 5.3 Oct 27, 2016
bootstrap.sh Increase minimum php version to reflect updated symfony requirements Jan 17, 2018
build.sh Allow skipping JS asset building in build script. Apr 17, 2019
composer.json Add documentation May 23, 2019
composer.lock Add documentation May 23, 2019
crowdin.yml Update as unapproved by default Mar 19, 2019
deploy.sh Fix config being cached too early in the build process. Nov 22, 2018
docker-compose.yml node image doesn't come with git Jun 10, 2019
generate-localizations.js rename command Mar 15, 2019
karma.conf.js move under tests Jun 7, 2019
osu!web.sublime-project RIP bower Oct 27, 2016
package.json types should only be devDependencies? Jun 7, 2019
phpunit.dusk.xml Missed phpunit settings for dusk Feb 8, 2019
phpunit.xml Default broadcast driver to log for testing Apr 18, 2019
server.php Update PHP files to use PSR-2 via StyleCI's checks Sep 3, 2015
travis-php.ini pecl-redis already installed Feb 18, 2019
tsconfig.json move test setup around Jun 7, 2019
tslint.json more rules Jun 6, 2019
webpack.config.js Update to latest laravel mix Dec 18, 2018
webpack.mix.js use dots Jul 3, 2019
yarn.lock setup karma Jun 7, 2019

README.md

osu!web

Build Status StyleCI Crowdin dev chat

The browser-facing portion of osu!.

Requirements

  • A PHP 7.1+ environment
  • MySQL 5.7
  • Elasticsearch

Getting Started

See the setup guide for a rundown on how to get a development environment up.

Contributing

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 from a design perspective 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.

If you wish to help with localisation efforts, head over to crowdin. If you're unsure of what you can help with, check out the list of open issues. If you're unsure of what you can help with, check out the list of open issues (especially those with the "good first issue" label).

Please see CONTRIBUTING.md for information about the code standards we expect from pull requests.

While we have standards in place, nothing is set in stone. If you have an issue with the way code is structured; with any libraries we are using; with any processes involved with contributing, please bring it up. We welcome all feedback so we can make contributing to this project as pain-free as possible.

For those interested, we love to reward quality contributions via bounties, paid out via paypal or osu! supporter tags. Don't hesitate to request a bounty for your work on this project.

Seeking Help

If you need help with anything, you have two options:

Create an Issue

If you have something you want to discuss in detail, or have hit an issue which you believe others will also have in deployment or development of the system, opening an issue is the best way to get help. It creates a permanent resource for others wishing to contribute to conversation. Please make sure to search first in case someone else has already addressed the same issue!

Discord

Alternatively, you can join the development discord for assistance.

Licence

osu!web is licensed under AGPL version 3 or later. Please see the licence file for more information. tl;dr if you want to use any code, design or artwork from this project, attribute it and make your project open source under the same licence.

You can’t perform that action at this time.