Skip to content

Latest commit

 

History

History
91 lines (73 loc) · 2.32 KB

File metadata and controls

91 lines (73 loc) · 2.32 KB

Contributing

Welcome, and thanks for your interest in contributing to Revisium! This document explains how to run the full stack locally for development and testing.

Local Development

Follow these steps to run the entire Revisium stack on your machine.

1. Prerequisites

  • Node.js: install the latest LTS. We recommend using nvm with an .nvmrc in each repo.
  • Docker & Docker Compose: ensure both are installed and running.

2. revisium-core

  1. Clone the repo and switch to its directory:
    git clone https://github.com/revisium/revisium-core.git
    cd revisium-core
  2. Copy and configure environment variables:
    cp .env.example .env
    # → edit `.env` (e.g. DATABASE_URL, REDIS_URL) as needed
  3. Install dependencies:
    npm install
  4. Start PostgreSQL and Redis:
    docker-compose up -d
  5. Apply database migrations and seed initial data:
    npm run prisma:migrate:deploy
    npm run prisma:generate
    npm run seed
  6. Launch the core service in debug mode:
    npm run start:debug

3. revisium-endpoint

  1. In a new terminal, clone and enter the endpoint repo:

    git clone https://github.com/revisium/revisium-endpoint.git
    cd revisium-endpoint
  2. Copy .env and install:

    cp .env.example .env
    npm install
  3. Generate prisma client:

    npm run prisma:generate
  4. Start the endpoint service in debug mode:

    npm run start:debug

4. revisium-admin

  1. In another terminal, clone and enter the admin repo:
    git clone https://github.com/revisium/revisium-admin.git
    cd revisium-admin
  2. Install dependencies and start the dev server:
    npm install
    npm run dev

5. Open the Admin UI


If you encounter any issues or have questions, please open an issue in the corresponding repo. We appreciate your contributions!