Skip to content

Latest commit

 

History

History
98 lines (61 loc) · 5.5 KB

README.md

File metadata and controls

98 lines (61 loc) · 5.5 KB
Raw

osu!web

Build Status

The future face of osu!.

Requirements

  • A PHP 7.1 (or equivalent) environment
  • MySQL 5.7+

For full support, we also recommend

  • Redis
  • Elasticsearch

Deploying

Environment

There are a few different options to get started:

  • Create a fresh Ubuntu environment and run sudo bootstrap.sh. Note that this script is intended to be run on a sandboxed environment; do not run it on a shared development system without first understanding what it does.
  • Use the php built-in server (run php -S 127.0.0.1:8080 from the public folder). You will still need a database backend.
  • Use Docker:
    • First, install Docker and Docker Compose, then run docker-compose up in the main directory.
    • Due to the nature of Docker (a container is killed when the command running in it finishes), the Yarn container will be run in watch mode.
    • If you use a non-standard user/group id (for example when your user wasn't the first one created on the system), you need to run the command as follows, with the env variables supplying your ids to the containers:
    bash
_UID=$(id -u) _GID=$(id -g) docker-compose up
    • Do note that the supplied Elasticsearch container uses a high (1+ GB) amount of RAM. Ensure that your system (or virtual machine, if running on Windows/macOS) has a necessary amount of memory allocated (at least 2 GB). If you can't (or don't want to), you can comment out the relevant elasticsearch lines in docker-compose.yml.
    • To run any of the below commands, make sure you are in the docker container: $ docker exec -it osuweb-php bash.
  • Use your existing web dev environment.

Creating user

$ php artisan tinker
>>> (new App\Libraries\UserRegistration(["username" => "yourusername", "user_email" => "[email protected]", "password" => "yourpassword"]))->save();

Generating assets

Using Laravel's Mix.

$ php artisan lang:js resources/assets/js/messages.js
$ yarn run development

Notice that if you use the bundled Docker Compose setup, Yarn/Webpack will be already run in watch mode, and you will only need to run the lang:js Artisan command whenever you need to regenerate the JS language helper.

Reset the database + Seeding sample data

$ php artisan migrate:refresh --seed

Run the above command to rebuild the database and seed with sample data. In order for the seeder to seed beatmaps, you must enter a valid osu! API key into your .env configuration file as it obtains beatmap data from the osu! API.

Developing

Generating assets while developing

To continuously generate assets as you make changes to files (less, coffeescript) you can run webpack in watch mode.

$ yarn run watch

Use of React vs Laravel Blade templates

For the time being, using React is generally preferred for pages which involve interaction beyond simple hyperlinks (ie. when state is present that can be modified by the user) or when real-time changes are presented to the user (ie. the state is volatile depending on back-end updates).

Use of BEM for CSS naming

Much of the CSS present abides to BEM conventions but there is also a fair deal that doesn't. We haven't come to a unanimous decision about how to proceed going forward, so please use your own discretion or continue the discussion in the relevant issue.

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.

Contributions can be made via pull requests to this repository. We hope to credit and reward larger contributions via a bounty system. If you're unsure of what you can help with, check out the list of available issues with bounty.

Note that while we already have certain 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. I welcome all feedback so we can make contributing to this project as easy as possible.

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 on 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!

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.