Eventyay

https://docs.eventyay.com/
Admin
Eventyay is an open-source event management platform by FOSSASIA. This unified documentation covers...
Tokens:553,315
Snippets:9,290
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start the video development server

Source: https://docs.eventyay.com/_sources/development/frontend.rst.txt

Commands to install dependencies and launch the development server for the video application.

```bash
cd app/eventyay/webapp/video
   npm install
   npm run dev
```

--------------------------------

### Manual environment setup

Source: https://docs.eventyay.com/_sources/video/developer/setup.rst.txt

Commands to install dependencies for non-docker development.

```bash
# Activate Python virtual environemnt with your preferred method.
# Go to "server" directory.
cd server
pip install -r requirements.txt
```

--------------------------------

### Start Schedule Editor

Source: https://docs.eventyay.com/talk/developer/frontend.html

Installs dependencies and starts the development server for the schedule editor.

```bash
cd app/eventyay/webapp/schedule-editor npm install npm run dev # Access: http://localhost:5173
```

--------------------------------

### Development Commands

Source: https://docs.eventyay.com/_sources/talk/developer/frontend.rst.txt

Commands for installing dependencies and starting the development server.

```bash
cd app/eventyay/webapp/schedule-editor
npm install
npm run dev
```

--------------------------------

### Development and Build Commands

Source: https://docs.eventyay.com/talk/developer/frontend.html

Standard CLI commands for installing dependencies, starting the development server, and building the production application.

```bash
> cd app/eventyay/webapp/schedule-editor npm install npm run dev
```

```bash
> npm run build # Output: dist/ directory
```

--------------------------------

### Install dependencies

Source: https://docs.eventyay.com/talk/developer/setup.html

Install the main application dependencies using uv.

```bash
uv sync
```

--------------------------------

### Full Widget Implementation Example

Source: https://docs.eventyay.com/_sources/user/events/widget.rst.txt

A complete example combining the assets and the widget tag.

```html
<link rel="stylesheet" type="text/css" href="https://eventyay.com/demo/democon/widget/v1.css">
<script type="text/javascript" src="https://eventyay.com/widget/v1.en.js" async></script>
<Eventyay-widget event="https://eventyay.com/demo/democon/"></Eventyay-widget>
<noscript>
   <div class="eventyay-widget">
        <div class="eventyay-widget-info-message">
            JavaScript is disabled in your browser. To access our ticket shop without javascript, please <a target="_blank" href="https://eventyay.com/demo/democon/">click here</a>.
        </div>
    </div>
</noscript>
```

--------------------------------

### Install application dependencies

Source: https://docs.eventyay.com/_sources/development/setup.rst.txt

Navigate to the app directory and install the required development dependencies.

```bash
cd app/
pip3 install -e ".[dev]"
```

--------------------------------

### Enable and Start Services

Source: https://docs.eventyay.com/_sources/admin/installation/manual_smallscale.rst.txt

Reload systemd configuration and start the web and worker services.

```bash
# systemctl daemon-reload
# systemctl enable eventyay-web eventyay-worker
# systemctl start eventyay-web eventyay-worker
```

--------------------------------

### Set up release environment

Source: https://docs.eventyay.com/_sources/talk/maintainer/release.rst.txt

Initialize a virtual environment and install necessary packaging tools.

```bash
mkvirtualenv eventyay-release && pip install -e . check-manifest twine wheel
```

--------------------------------

### Start the full stack environment

Source: https://docs.eventyay.com/_sources/development/frontend.rst.txt

Commands to initialize the backend and video frontend services.

```bash
cd app
   make run
```

```bash
cd app/eventyay/webapp/video
   npm install
   npm run dev
```

--------------------------------

### Import sample configuration

Source: https://docs.eventyay.com/_sources/video/developer/setup.rst.txt

Populates the database with basic event data for testing.

```bash
docker-compose exec server python manage.py import_config sample/worlds/sample.json
```

--------------------------------

### Build and serve documentation

Source: https://docs.eventyay.com/_sources/development/setup.rst.txt

Commands to install documentation dependencies, build the HTML output, and run a live-reloading server.

```bash
cd doc/
pip3 install -r requirements.txt
```

```bash
make html
```

```bash
pip3 install sphinx-autobuild
sphinx-autobuild . _build/html -p 8081
```

--------------------------------

### Get Badge Layout Response

Source: https://docs.eventyay.com/plugins/badges.html

Example JSON response for a single badge layout.

```json
HTTP/1.1 200 OK
Vary: Accept
Content-Type: text/javascript

{
  "id": 1,
  "name": "Default layout",
  "default": true,
  "layout": {},
  "background": {},
  "item_assignments": []
}
```

--------------------------------

### Get Single Gift Card Response

Source: https://docs.eventyay.com/api/resources/giftcards.html

Example response for a single gift card resource.

```JSON
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "id": 1,
  "secret": "HLBYVELFRC77NCQY",
  "currency": "EUR",
  "testmode": false,
  "expires": null,
  "conditions": null,
  "value": "13.37"
}
```

--------------------------------

### Set up local development environment

Source: https://docs.eventyay.com/_sources/development/unified_architecture.rst.txt

Commands to clone the repository, configure the virtual environment, install dependencies, and initialize the development server.

```bash
# Clone the repository
git clone https://github.com/fossasia/eventyay.git
cd eventyay

# Set up the app directory
cd app
python -m venv venv
source venv/bin/activate

# Install dependencies
pip install -e .

# Run migrations
python manage.py migrate

# Create superuser
python manage.py createsuperuser

# Run development server
python manage.py runserver
```

--------------------------------

### Initialize Configuration File

Source: https://docs.eventyay.com/_sources/video/admin/setup.rst.txt

Create the configuration directory and file with appropriate permissions.

```bash
# mkdir /etc/eventyay
# touch /etc/eventyay/eventyay.cfg
# chown -R 15371:15371 /etc/eventyay/
# chmod 0700 /etc/eventyay/eventyay.cfg
```

```ini
[Eventyay]
url=https://eventyay.mydomain.com
short_url=https://shorturl.com
```

--------------------------------

### Setup Configuration Directory

Source: https://docs.eventyay.com/_sources/admin/installation/manual_smallscale.rst.txt

Creates the configuration directory and file with appropriate ownership and permissions.

```bash
# mkdir /etc/eventyay
# touch /etc/eventyay/eventyay.cfg
# chown -R eventyay:eventyay /etc/eventyay/
# chmod 0600 /etc/eventyay/eventyay.cfg
```

--------------------------------

### Retrieve Event Items Request

Source: https://docs.eventyay.com/_sources/api/resources/items.rst.txt

Example HTTP GET request to fetch all items for a specific event.

```http
GET /api/v1/organizers/bigevents/events/sampleconf/items/ HTTP/1.1
Host: eventyay.com
Accept: application/json, text/javascript
```

--------------------------------

### Initialize and run server

Source: https://docs.eventyay.com/_sources/video/developer/setup.rst.txt

Commands to run migrations, create a superuser, and start the development server.

```bash
./manage.py migrate
```

```bash
./manage.py createsuperuser
```

```bash
./manage.py runserver
```

--------------------------------

### Retrieve events list request

Source: https://docs.eventyay.com/_sources/api/resources/events.rst.txt

Example HTTP GET request to fetch all events for a specific organizer.

```http
GET /api/v1/organizers/bigevents/events/ HTTP/1.1
Host: eventyay.com
Accept: application/json, text/javascript
```

--------------------------------

### Initialize database

Source: https://docs.eventyay.com/development/setup.html

Run migrations to set up the local database.

```bash
python manage.py migrate
```

--------------------------------

### Dockerfile for Enterprise Plugin

Source: https://docs.eventyay.com/_sources/admin/installation/enterprise.rst.txt

Example Dockerfile configuration to include the SSH key and install the enterprise plugin.

```dockerfile
FROM fossasia/eventyay-tickets:stable
USER root
COPY id_eventyay_enterprise /root/.ssh/id_rsa
COPY id_eventyay_enterprise.pub /root/.ssh/id_rsa.pub
RUN chmod -R 0600 /root/.ssh && \
    mkdir -p /etc/ssh && \
    ssh-keyscan -t rsa -p 10022 code.rami.io >> /root/.ssh/known_hosts && \
    echo StrictHostKeyChecking=no >> /root/.ssh/config && \
    DJANGO_SETTINGS_MODULE=eventyay.settings pip3 install -U "git+ssh://git@code.rami.io:10022/eventyay/eventyay-slack.git@stable#egg=eventyay-slack" && \
    cd /eventyay/src && \
    sudo -u pretixuser make production
USER pretixuser
```

--------------------------------

### Retrieve list of orders request

Source: https://docs.eventyay.com/_sources/api/resources/orders.rst.txt

Example request to fetch all orders for a specific event using the GET method.

```http
GET /api/v1/organizers/bigevents/events/sampleconf/orders/ HTTP/1.1
Host: eventyay.com
Accept: application/json, text/javascript
```

--------------------------------

### Initialize database and application

Source: https://docs.eventyay.com/_sources/talk/administrator/installation.rst.txt

Compiles static files, runs migrations, and initializes the administrator account.

```bash
(venv)$ python -m eventyay migrate
(venv)$ python -m eventyay rebuild
(venv)$ python -m eventyay init
```

--------------------------------

### Complete Widget Implementation Example

Source: https://docs.eventyay.com/_sources/talk/user/event/widget.rst.txt

A full example showing the script tag with async loading and the widget container with custom styling.

```html
<script type="text/javascript" src="https://eventyay.com/democon/schedule/widget/v2.en.js" async></script>

<div style="overflow-x: auto; width: calc(100% + 100px); padding-right: 12px">
<Eventyay-schedule event-url="https://eventyay.com/democon/" locale="en" style="--Eventyay-clr-primary: #3aa57c;"></Eventyay-schedule>
</div>
<noscript>
   <div class="eventyay-widget">
        <div class="eventyay-widget-info-message">
            JavaScript is disabled in your browser. To access our schedule without JavaScript,
            please <a target="_blank" href="https://eventyay.com/democon/schedule/">click here</a>.
        </div>
    </div>
</noscript>
```

--------------------------------

### Retrieve an Event Item Request

Source: https://docs.eventyay.com/_sources/api/resources/items.rst.txt

Example HTTP GET request to fetch details for a specific item by its ID.

```http
GET /api/v1/organizers/bigevents/events/sampleconf/items/1/ HTTP/1.1
Host: eventyay.com
Accept: application/json, text/javascript
```

--------------------------------

### Retrieve Question Details

Source: https://docs.eventyay.com/_sources/api/resources/questions.rst.txt

Example of a successful HTTP GET response containing question metadata and available options.

```http
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "id": 1,
  "question": {"en": "T-Shirt size"},
  "help_text": {"en": "Choose your preferred t-shirt-size"},
  "type": "C",
  "required": false,
  "items": [1, 2],
  "position": 2,
  "identifier": "WY3TP9SL",
  "ask_during_checkin": false,
  "hidden": false,
  "print_on_invoice": false,
  "dependency_question": null,
  "dependency_value": null,
  "dependency_values": [],
  "valid_number_min": null,
  "valid_number_max": null,
  "valid_date_min": null,
  "valid_date_max": null,
  "valid_datetime_min": null,
  "valid_datetime_max": null,
  "options": [
    {
      "id": 1,
      "identifier": "LVETRWVU",
      "position": 1,
      "answer": {"en": "S"}
    },
    {
      "id": 2,
      "identifier": "DFEMJWMJ",
      "position": 2,
      "answer": {"en": "M"}
    },
    {
      "id": 3,
      "identifier": "W9AH7RDE",
      "position": 3,
      "answer": {"en": "L"}
    }
  ]
}
```

--------------------------------

### Start Development Environment

Source: https://docs.eventyay.com/_sources/video/frontend.rst.txt

Commands to launch the backend and frontend services for local development.

```bash
# Start backend first
cd app
make run

# In another terminal, start frontend
cd app/eventyay/webapp/video
npm run dev

# Access: http://localhost:8880
```

--------------------------------

### Initialize database and static files

Source: https://docs.eventyay.com/_sources/talk/developer/setup.rst.txt

Prepare the local database and collect static assets.

```shell
(.venv)$ cd app
(.venv)$ python manage.py collectstatic --noinput
(.venv)$ python manage.py migrate
```

--------------------------------

### Create custom Dockerfile for plugins

Source: https://docs.eventyay.com/_sources/admin/installation/docker_smallscale.rst.txt

Example Dockerfile configuration to install additional plugins into the base Eventyay image.

```dockerfile
FROM eventyay/standalone:stable
USER root
RUN pip3 install eventyay-passbook
USER eventyayuser
RUN cd /eventyay/src && make production
```

--------------------------------

### Start development server

Source: https://docs.eventyay.com/_sources/talk/developer/setup.rst.txt

Launch the local development server.

```shell
(.venv)$ python manage.py runserver
```

--------------------------------

### Retrieve Revoked Secrets Request

Source: https://docs.eventyay.com/_sources/api/resources/orders.rst.txt

Example HTTP GET request to fetch the list of revoked secrets for a specific event.

```http
GET /api/v1/organizers/bigevents/events/sampleconf/revokedsecrets/ HTTP/1.1
Host: eventyay.com
Accept: application/json, text/javascript
```

--------------------------------

### Backend Startup

Source: https://docs.eventyay.com/_sources/talk/developer/frontend.rst.txt

Command to initialize the backend service.

```bash
cd app
make run
```

--------------------------------

### Fetch webinar host URLs request

Source: https://docs.eventyay.com/_sources/plugins/webinar.rst.txt

Example HTTP GET request to retrieve webinar configurations for a specific event.

```http
GET /api/v1/organizers/bigevents/events/sampleconf/webinars/ HTTP/1.1
Host: eventyay.com
Accept: application/json, text/javascript
```
Tokens:
Raw