Skip to main content

Operation

This page outlines how to successfully operate the application

Configuration Pre-Requisites​

You will first need to create a .env file as described in the Configuration Guide

Operation Using Docker​

Docker is used to build, deploy, and manage applications within isolated, lightweight containers, effectively packaging an application with all its dependencies so it can run consistently across different environments, allowing for faster development, testing, and deployment of software.

We use it to simplify installation

Prerequisites​

Follow these steps to install Docker on your system:

  1. The steps are different for Windows/Mac versus Linux users:

    1. Docker Desktop for Windows/Mac
    2. Docker Engine for Linux

  2. You must ensure that docker is running for the Talawa-Admin application to work correctly.

The next steps will depend on whether you are:

  1. an end user installing our software (Production Environments) or
  2. one of our open source contributors (Development Environments).

Please follow them closely.

For Production Environments​

This section describes how to setup the application in a production environment.

  1. Configure nginx.conf file located at config/docker/setup. Modify it to fit your preferences before running the application.

  2. Build and Run the Docker Image:

    Run the following command to run the Docker image:

    docker-compose -f docker/docker-compose.prod.yaml --env-file .env up

    or

    docker compose -f docker/docker-compose.prod.yaml --env-file .env up

  3. To stop the container run the following command:

    docker-compose -f docker/docker-compose.prod.yaml down

    or

    docker compose -f docker/docker-compose.prod.yaml down

    The application will be accessible at http://localhost:4321

For Development Environments​

This section describes how to setup the application in a development environment.

  1. Build and Run the Docker Image:

    Run the following command to run the Docker image:

    docker-compose -f docker/docker-compose.dev.yaml --env-file .env up

    or

    docker compose -f docker/docker-compose.dev.yaml --env-file .env up

  2. To stop the container run the following command:

    docker-compose -f docker/docker-compose.dev.yaml down

    or

    docker compose -f docker/docker-compose.dev.yaml down

The application will be accessible at http://localhost:4321

Operation Without Docker​

If you are running Talawa-Admin natively then the next steps will depend on whether you are:

  1. an end user installing our software (Production Environments) or
  2. one of our open source contributors (Development Environments).

Please follow them closely.

For Production Environments​

Run the following command to start the development server:

pnpm run serve

For Development Environments​

Run the following command to start the production server:

pnpm run serve &