googlefonts / django-robo-cjk

server-side engine :gear: based on python + django + MySQL of the robo-cjk plugin.

django-robo-cjk

django-robo-cjk is the server-side engine based on python and django that serves the robo-cjk RoboFont plugin and the fontra-rcjk Fontra plugin.

Its purpose is to centralize and speed-up the design/development of CJK typefaces providing a whole set of APIs to manage .rcjk projects.

Installation

Requirements

• Python >= 3.11 is necessary to use this project locally or remotely.
• MySQL (we use this project with a MySQL database, but other databases can be used)
• Nginx (we use nginx as webserver in our remote environment)
• Gunicorn (we use gunicorn as appserver in our remote environment)

Setup

# create project directory
mkdir myrcjkfont && cd myrcjkfont

# create virtualenv and activate it
python -m venv venv && . venv/bin/activate

# clone repository
git clone https://github.com/googlefonts/django-robo-cjk.git src/ && cd src/

# upgrade pip
python -m pip install --upgrade pip

# install requirements
pip install -r requirements.txt

# install pre-commit to run formatters and linters
pre-commit install --install-hooks

# create environment settings file
mkdir conf && touch conf/env_settings

Configuration

Add the following environment settings to conf/env_settings file and configure them:

# django admin properties used for sending error emails
ADMIN_NAME=""
ADMIN_EMAIL=""

# django allowed hosts (separated by comma)
ALLOWED_HOSTS=""

# django database
DATABASE_ENGINE=""
DATABASE_NAME=""
DATABASE_USER=""
DATABASE_PASSWORD=""

# django debug
DEBUG=True
DEBUG_TOOLBAR_SHOW=True

# django email
EMAIL_HOST="smtp.gmail.com"
EMAIL_HOST_USER=""
EMAIL_HOST_PASSWORD=""

# git settings
GIT_REPOSITORIES_PATH="/your-path/.rcjks"
GIT_USER_EMAIL=""
GIT_USER_NAME=""

# hashids settings - https://pypi.org/project/hashids/
HASHIDS_SALT=""

# jwt settings - https://pypi.org/project/jwt/
JWT_SECRET=""

# django media and static files
MEDIA_ROOT="/your-path/robocjk/public/media/"
STATIC_ROOT="/your-path/robocjk/public/static/"

# export options
ROBOCJK_EXPORT_CANCEL_TIMEOUT=120
ROBOCJK_EXPORT_QUERIES_PAGINATION_LIMIT=500

# django secret key
SECRET_KEY=""

# sentry
SENTRY_DSN=""
SENTRY_ENVIRONMENT=""

# api testing
TEST_API_HOST=""
TEST_API_USERNAME=""
TEST_API_PASSWORD=""

Check

• Run python manage.py check
• Run python manage.py runserver

API

• Globals
• Endpoints
• Client

License

Released under GNU General Public License v3.0.