Rūrusetto (ルールセット)

A wiki that contain all osu! rulesets

The new era of Rūrusetto is beginning!

About the new website

The new website is target to revamp all UI of the website and make Rūrusetto not a static website anymore with a lot of new function that cannot add in old website source code.

You can test on the new website here and you can check on the changelog in website or GitHub release.

Old website source code

An old source code of the website is in the other branch

The main website will use the old source code until I am sure that the new code can be used now.

About question on new website I already write an explanation on this.

Developing Rūrusetto

Please make sure you have the following prerequisites:

Python 3.7 or better
During development on codebase, we recommend IDE with intelligent code completion and syntax highlighting if you work with a codebase. Our recommendation is PyCharm or Visual Studio Code
Git

Downloading the source code

Clone the repository:

git clone https://github.com/Rurusetto/rurusetto/
cd rurusetto

To update the source code to the latest commit, run the following command inside the Rūrusetto directory:

git pull

Make the virtual environment

During the development progress, we recommend using the virtual environment during development progress.

First, make the folder to contain the virtual environment in Rūrusetto directory. Then build the virtual environment.

cd rurusetto
mkdir venv
python3 -m venv rurusettovenv

When you want to access the virtual environment just use source command and link to activate file to activate the virtual environment file in Rūrusetto directory.

source rurusettovenv/bin/activate

And when you want to get off from the virtual environment, use the deactivate command.

deactivate

Note : If you use PyCharm, you can click on the python interpreter and you can add the new interpreter to create a new virtual environment and when you run the command in PyCharm terminal all command will stay in virtual environment.

Install the requirement library in the virtual environment

When you start the virtual environment, you need to install the requirement that listing in requirements.txt file. Run this command in Rūrusetto directory:

pip install -r requirements.txt

Make the database

Before we can start the server, we must make a database for the website by migrate the database from the code. Run this command in Rūrusetto directory to make the database.

cd rurusetto # get in the Rūrusetto project config folder
python manage.py migrate

Fill the configuration value and secret key

Rūrusetto use python-decouple library to separate the configuration value and secret key. This library will read the configuration value from .env file. Let's create the .env file in rurusetto folder and below are the template for this file.

SECRET_KEY = awesome_key_here
DEBUG = True
ALLOWED_HOSTS = 127.0.0.1
OSU_OAUTH_CLIENT_ID = idgohere
OSU_OAUTH_CLIENT_SECRET = keygohere
OSU_API_V1_KEY = keygohere

Note : The OSU_OAUTH_CLIENT_ID OSU_OAUTH_CLIENT_SECRET and OSU_API_V1_KEY are required when you want to development with osu! OAuth system or some program part that required the osu! API you must fill the osu! API key and OAuth app number in settings.py to start development on this function. But if you are not testing on this function it's okay to leave the key blank. (The development OAuth server callback is http://127.0.0.1:8000/accounts/osu/login/callback/.)

Start the development server

Run the runserver command in Rūrusetto directory

cd rurusetto # get in the Rūrusetto project config folder
python manage.py runserver

Contributing

When it comes to contributing to the project, the two main things you can do to help out are reporting the issues and submitting pull requests. We have prepared a list of contributing guidelines that should hopefully ease you into our collaboration process.

Note that the contributing guidelines is not exhaustive. Nothing is set in stone. If you have an issue with the way code is structure, with any libraries we are using, or with any processes involved with contributing, please bring up and ask us! We welcome all feedback, so we can make contributions to this project as painless as possible.

We use code of conduct from Contributor Covenant.

License

The code in this repository is licensed under MIT license. Please see the license file for more information.

TL;DR you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.

The image in this website and the content that upload by user and community are cover by DMCA. If you are the work owner and want to request to remove your work, please email the team at contact@rulesets.info or contact HelloYeew (project leader) at me@helloyeew.dev.

Each rulesets has its own license.

The licensing here does not directly apply to osu! and ppy, as it is bound to its own licensing.

pontakornth/rurusetto