Eventyay

Eventyay is an open source event management platform by FOSSASIA <https://fossasia.org>_. It provides event ticketing, registration, call for participation, speaker and session management, scheduling, online event video, attendee check-in, badge printing, organiser administration, APIs, and plugin based extensions.

Eventyay has been in development since 2014. Parts of the system historically originated from separate components for tickets, talks, and video. The current repository contains the unified Eventyay codebase.

Contents

• Project status and branch model_
• Main features_
• Technology stack_
• Quick start with Docker_
• Python based local development_
• Frontend development_
• Configuration overview_
• Plugins and extensions_
• Separate Eventyay components_
• Translation workflow_
• Common development commands_
• API and service endpoints_
• Repository layout_
• Architecture rules for contributors_
• Troubleshooting_
• Deployment_
• Documentation_
• Contributing_
• Legal and licensing_

Project status and branch model

Eventyay is actively developed.

The repository uses the following branch model:

• main is the production ready branch.
• dev is the testing and active development branch.

Pull requests should normally target dev. Changes are tested and stabilised there before they are moved to main for production ready releases.

Main features

Eventyay includes:

• Event ticketing and registration
• Event related item sales, such as shirts or add ons
• Organiser and event administration
• Call for Participation workflows
• Speaker, submission, review, and schedule management
• Public event pages
• Schedule display and schedule editor frontends
• Online event and video related workflows
• Separate check-in station support through the Eventyay Checkin component
• PDF ticket and badge related workflows
• REST API endpoints
• OAuth and social authentication support
• Multi domain and multi event handling
• Plugin discovery and plugin URL registration
• Standard plugins and external plugin extensions for payments, CRM, exhibitions, social media, team shifts, interpretation, and spatial event integrations
• Email, notifications, scheduled tasks, reports, statistics, and check-in lists
• Health check and metrics endpoints
• Internationalisation and translation infrastructure with Hosted Weblate based browser translation workflow

Technology stack

Backend:

• Python 3.12
• Django 5.2
• Django REST Framework
• PostgreSQL
• Redis
• Celery
• Django Channels
• Daphne / ASGI
• Pydantic settings
• uv for Python dependency management

Frontend:

• Vue 3
• Vite
• JavaScript and TypeScript depending on the frontend module
• SCSS / Stylus
• Django Compressor for selected legacy and Django integrated assets

Quick start with Docker

Docker is the recommended way to start quickly for local development and first testing. For production or self-hosted server deployment, see the Deployment_ section below and DEPLOYMENT.md.

The local Docker stack starts the Django web service, Celery worker, Celery beat, Redis, and PostgreSQL. It also mounts ./plugins for local plugin development.

Requirements:

• Docker
• Docker Compose plugin
• Git

Steps:

.. code-block:: bash

git clone https://github.com/fossasia/eventyay.git cd eventyay git switch dev

cp deployment/env.dev.sample .env.dev

docker compose up -d --build

Create an admin user:

.. code-block:: bash

docker exec -ti eventyay-next-web python manage.py create_admin_user

Open the local site:

.. code-block:: text

http://localhost:8000

View logs:

.. code-block:: bash

docker compose logs -f

Stop the development stack:

.. code-block:: bash

docker compose down

The directory app/eventyay is mounted into the Docker container, so live editing of backend code is supported.

Python based local development

Use this setup when you want to run services directly on your machine.

Requirements:

• Python 3.12
• uv <https://docs.astral.sh/uv/getting-started/installation/>_
• PostgreSQL
• Redis
• Node.js and npm
• Debian or Ubuntu packages listed in deb-packages.txt or equivalent packages for your distribution

Clone the repository:

.. code-block:: bash

git clone https://github.com/fossasia/eventyay.git cd eventyay git switch dev

Install external dependencies on Debian or Ubuntu:

.. code-block:: bash

xargs -a deb-packages.txt sudo apt install

For Nushell:

.. code-block:: nu

open deb-packages.txt | lines | sudo apt install ...$in

If you are using another Linux distribution, install the corresponding packages from deb-packages.txt.

Install uv <https://docs.astral.sh/uv/getting-started/installation/>_.

Install and run Redis according to your distribution.

Create a PostgreSQL database. The default local database name is:

.. code-block:: text

eventyay-db

On Linux, the simplest local development setup is PostgreSQL peer mode. Create a PostgreSQL user with the same name as your Linux user:

.. code-block:: bash

sudo -u postgres createuser -s "$USER"

Then create a database owned by your user:

.. code-block:: bash

createdb eventyay-db

You can then access the database without specifying a password, host, or port:

.. code-block:: bash

psql eventyay-db

If you cannot use PostgreSQL peer mode, create app/eventyay.local.toml with database connection values:

.. code-block:: toml

postgres_user = "your_db_user" postgres_password = "your_db_password" postgres_host = "localhost" postgres_port = 5432

Enter the app directory:

.. code-block:: bash

cd app

Install Python dependencies:

.. code-block:: bash

uv sync --all-extras --all-groups

Activate the virtual environment:

.. code-block:: bash

. .venv/bin/activate

Run migrations:

.. code-block:: bash

python manage.py migrate

Create an admin user:

.. code-block:: bash

python manage.py create_admin_user

Build frontend and static assets:

.. code-block:: bash

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗