Getting Started

This guide will help you set up and run the Wapy.dev application.

Requirements

Before starting, ensure you have the following:

SMTP Email Server Configuration

Required for handling authentication emails and email notifications. (Self-hosting without an SMTP server? Here's how to configure Mailpit as an alternative.)

[Optional] Github OAuth keys

Only if you want to enable Github login.

[Optional] Google OAuth keys

Only if you want to enable Google login.

[Optional] Keycloak/Authentik OAuth keys

Only if you want to use Keycloak and/or Authentik for self-hosters. (Integration guide)

Installation

Set Up Environment Variables

The application requires environment variables to function properly.

• Download or copy the following files from the repository

  • docker-compose.yml
  • .env.example
  • scripts/setup.sh

• Place the setup.sh file in the scripts folder, if not already.

• Run the setup script to generate the .env file.

  The setup script will help you by copying .env.example to .env and generating some of the environment variables automatically.

  # On Linux (openssl and npm required)
  chmod +x ./scripts/setup.sh && ./scripts/setup.sh
  # or using Docker
  docker run --rm --volume ./:/app --workdir /app node:latest bash -c "./scripts/setup.sh"
  # On using Docker on Windows
  docker run --rm --volume ${PWD}:/app --workdir /app node:latest bash -c "./scripts/setup.sh"

  Alternatively, you can copy the .env.example file to .env and manually set the required environment variables.

• Review the .env file to understand the variables you need to configure.

  • Add your SMTP email server configuration to the .env file.
  • Please see Environment Variables for the documentation.

Production Setup

To start the application in production mode, run:

docker compose -p wapydev up -d

The docker-compose.yml file includes both the database and server. After successful deployment, you can visit your domain URL to see the application.

Development Setup

To start the application in development mode:

• Clone the repository

mkdir -p wapy.dev && cd wapy.dev && git clone https://github.com/meceware/wapy.dev.git .

• Start the application in development mode

docker compose -p wapydev-dev -f docker-compose-dev.yml up -d

This setup uses the docker-compose-dev.yml file for development-specific configurations.