Skip to main content

Installation

This guide explains how to install and configure OchoCast locally.

Prerequisites​

  • Git installed
  • Docker and Docker Compose
  • Node.js (recommended: LTS)
  • npm or yarn

1. Clone the project​

Clone the repository from GitHub:

git clone <GITHUB_REPO_URL>
cd octocast-webapp

2. Start services with Docker​

From the project root, run:

docker-compose up -d

This docker-compose.yml brings up the necessary services.

3. Keycloak configuration​

Keycloak is used for user authentication.

  1. Go to the localKeycloak folder:
cd localKeycloak
cp .env.example .env

  1. Open http://localhost:8080 in your browser to access Keycloak.

  2. The local realm is usually imported automatically via Docker Compose, but no users are created by default.

Creating a user in Keycloak​

  1. Open the Keycloak admin console.
  2. Select your realm from the dropdown.
  3. Click “Users”, then “Add User”.
  4. Fill in username, email, first name and last name.
  5. Click “Save”.
  6. In the “Credentials” tab, set a password for the user.

4. Backend configuration​

  1. Go to the backend folder:
cd backend
cp .env.example .env
  1. Copy the nest-back client secret from Keycloak into the AUTH_SECRET environment variable.

5. Frontend configuration​

  1. Ensure the database and Keycloak are configured.
  2. Go to the frontend folder:
cd frontend
cp .env.example .env
  1. Copy environment variables from .env.example to .env and configure them as needed.

6. Start the application​

After configuration, start the project.

Install dependencies​

In the frontend folder run:

npm install

Start the frontend​

npm start

You can also run the backend and frontend together from the project root.

Verification​

  • Keycloak should be available at http://localhost:8080.
  • Backend should be accessible at http://localhost:<BACKEND_PORT>.
  • Frontend should be accessible at http://localhost:<FRONTEND_PORT>.

OchoCast is ready to use​

If you encounter issues, verify environment variables and ensure all Docker services are up.