Welcome to Weasyl!

Weasyl is a social gallery website designed for artists, writers, musicians, and more to share their work with other artists and fans. We seek to bring the creative world together in one easy to use, friendly, community website.

Starting a Weasyl development environment

Requirements:

• Docker
• docker compose (included with Docker on Windows and macOS)

Get the sample database

Save https://pypi.weasyl.dev/02-weasyl-latest-staff.sql.gz into the containers/postgres/ directory.

Configure services

This copies the sample configuration into the config volume, and only needs to be done each time the volume is recreated or the sample configuration changes.

./wzl configure

Run database migrations

./wzl migrate

Copy assets

./wzl assets

Start Weasyl

Start all the remaining Weasyl services in the background:

./wzl up -d

Future changes to the application server can be applied with ./wzl up -d --build web.

You can check its logs with ./wzl logs web, or attach to it with ./wzl up web. Detaching can be done from another shell with pkill -x -HUP docker-compose. Inspecting the database can be done with ./wzl exec postgres psql -U weasyl.

Weasyl should now be running at http://weasyl.localhost:8080/! Several accounts are already created for you with a default password of password. Login as ikani for director-level access, or see the contents of ./config/weasyl-staff.example.py for accounts with other permission levels.

Running tests

./wzl test

Making migrations

./wzl revision --autogenerate -m 'Revision summary'

Troubleshooting and getting help

If you have questions or get stuck, you can try talking to Weasyl project members in the project’s Gitter room.

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Style guide

When committing code, be sure to follow the Style and Best Practices Guide.