Berryllium

Berryllium is the software behind the mod-hosting website ZooBerry. It is a Django app!

(Still in development and not yet live)

Setup

1. Clone the repository

git clone git@github.com:zooberryorg/berryllium.git

2. Create a Python virtual environment and activate it

3. Install the dependencies

pip install -r requirements.txt

4. Create a .env file in the root of the project and add the following environment variables (no variables yet)

5. Build containers

docker build . -t berryllium

Local server instance will be accessible at http://localhost:8001

6. Run the containers

docker-compose up

Development

UX/UI

To setup UX/UI development, make sure you have Node.js and npm installed. In a separate terminal, run Tailwind CLI to watch for changes in the templates and update the project's CSS file:

npx @tailwindcss/cli -i ./.tw/input.css -o ./berryllium/shared/static/shared/css/be.css --watch

For more information, see the Tailwind CLI documentation.

Linters and Formatters

For Django templates, we use djlint. It can be used as both a linter and a formatter.

To lint:

djlint .

To format:

djlint . --reformat

For Python code linting and formatting, we use Ruff.

To lint:

ruff check

To format:

ruff format