Contribute

Our project is open-source and open for contributions. We would be more than happy to accept your pull-requests on GitHub.

The website has been made using Django, the facemash has been made using Pyramid, and the public API has been made using Django-Rest-Framework, so in Python 2. We also use LESS CSS, Bootstrap, JQuery and Bower for the front-end of the website.

If you wish to contribute but you don't know what to do, feel free to browse tasks that are ready to be implemented:

Main contributors are db0 and Lamagicien.

School Idol Tomodachi Website & API

and contest

Repository

SchoolIdolTomodachi/SchoolIdolAPI

Contributors Guide

Install the 1st time

# Install pre-requirements
# Debian, Ubuntu, and variants
apt-get install libpython-dev libffi-dev python-virtualenv libmysqlclient-dev nodejs
# Arch
pacman -S libffi python-virtualenv libmysqlclient nodejs

# Clone the repo
git clone https://github.com/SchoolIdolTomodachi/SchoolIdolAPI.git
cd SchoolIdolAPI

# Create a virtualenv to isolate the package dependencies locally
virtualenv env
source env/bin/activate

# Install packages, no need to be root
pip install -r requirements.txt

# Create tables, initialize database
python manage.py migrate

# Fill database with cards
python manage.py importcards noimages
# The `noimages` option will prevent downloading all the images, which may take hours.
# You can omit this option if what you're doing requires images.

# Compile localized messages
python manage.py compilemessages

# Download front-end dependencies
npm install -g bower less
bower install

# Compile LESS to CSS
lessc -x web/static/less/style.less web/static/css/style.css

# Launch the server
python manage.py runserver

# Then open your browser to http://localhost:8000 to see the website

Anytime

Reactivate the environment

source env/bin/activate

Launch the server

python manage.py runserver

If you want it to be externally visible, add an extra argument 0.0.0.0:8000.

No need to restart it to see your modifications, the server reloads itself automatically.

Whenever you change the models

python manage.py makemigrations
python manage.py migrate

Whenever you add messages that should be translated

Generate terms:

python manage.py makemessages -l ja --ignore=env/* --ignore=schoolidolapi/settings.py --ignore=api/models_languages.py --ignore=web/templates/registration/*

Then go to POEditor and import the tems. When the new terms are translated in all languages, generate the new files and put them in the repo. Either manually or using the POEditor integration.

Compile all languages

python manage.py compilemessages

Go further

• More commands available to manage your instance of the website: Django Commands
• Configure your instance of the website: Django Configuration

School Idol Trivia

Repository

SchoolIdolTomodachi/lltrivia

Contributors Guide

See School Idol Trivia repo README