Local Development

This guide will walk you through setting up a local development environment for Lumigator backend. This is useful for testing changes to the backend codebase during development or for debugging issues. Reading this guide is a must if you are planning to contribute to the Lumigator backend codebase.

Backend Setup

You can deploy and develop Lumigator locally using Docker Compose. Start by running the following command:

user@host:~/lumigator$ make local-up

This creates three container services networked together to make up all the components of the Lumigator application:

  • localstack: Local storage for datasets that mimics S3-API compatible functionality.

  • backend: Lumigator’s FastAPI REST API.

  • ray: a Ray cluster for submitting lm-buddy jobs and serving Ray Serve.

The local-up make target will also set a watch on the backend codebase, so that any changes you make to the codebase will be automatically reflected in the running backend service (see here). Moreover, it will mount the local.db database file to the backend service, so that any changes you make to the database will be persisted between runs.

To use the API-based vendor ground truth generation and evaluation, you’ll need to pass the following environment variables for credentials, into the docker container:

  • MISTRAL_API_KEY: You Mistal API key.

  • OPENAI_API_KEY: Your OpenAI API key.

Testing the backend services

You can test your local setup as follows:

  • SQLite: Connect to your database with any SQL client that supports SQLite (e.g., DBeaver).

  • localstack: Test your localstack setup as follows:

    • Install s5smd, a very fast S3 and local filesystem execution tool, by running:

      brew install peak/tap/s5cmd

    • Export the folowing environment variables:

      export AWS_ACCESS_KEY_ID=test
export AWS_SECRET_ACCESS_KEY=test
export AWS_DEFAULT_REGION=us-east-2
export AWS_ENDPOINT_URL=http://localhost:4566

    • Set the following alias for convenience:

      alias s5='s5cmd --endpoint-url $AWS_ENDPOINT_URL'

    • Check out the storage: s5 ls

    • Check out the lumigator bucket: s5 ls s3://lumigator-storage.

    • Check out the localstack image documentation here.

  • backend: Connect to Lumigator’s OpenAPI spec at localhost, see the available endpoints, and interactively run commands.

  • ray: Connect to Ray’s dashboard via HTTP to this address, see the cluster status, running jobs, their logs, etc.

Frontend Setup

This guide can be used to build and run the Lumigator frontend (UI) for development or production environments.

Prerequisites

Ensure you have the following installed on your system:

  • Node.js (version 14 or higher)

  • npm or yarn package manager

Installation

  1. Clone the repository (if you haven’t already):

    Using HTTPS:

    user@host:~$ git clone https://github.com/mozilla-ai/lumigator.git

    Or using SSH:

    user@host:~$ git@github.com:mozilla-ai/lumigator.git

  2. Navigate to the lumigator/frontend directory:

    user@host:~$ cd lumigator/lumigator/frontend

  3. Install dependencies:

    Using npm:

    user@host:~/lumigator/lumigator/frontend$ npm install

    Or using yarn:

    user@host:~/lumigator/lumigator/frontend$ yarn install

Development

To run the frontend locally for development purposes, use the following command to start the Vite development server. This will also enable hot-reloading, so changes you make in the code will be reflected instantly in the browser.

user@host:~/lumigator/lumigator/frontend$ npm run dev

Or using yarn:

user@host:~/lumigator/lumigator/frontend$ yarn dev

Visit http://localhost:3000 in your browser. The application runs at this address by default.

Build for Production

To build the frontend for production, run:

user@host:~/lumigator/lumigator/frontend$ npm run build

This command will bundle the frontend code into a production-ready, optimized set of static assets located in the dist directory. By default dist is placed in project’s root directory ( ./lumigator/frontend in this case).

Linting and Code Formatting

For consistent code formatting and linting across multiple contributors, ESLint and Prettier are configured. To run linting:

user@host:~/lumigator/lumigator/frontend$ npm run lint

To fix linting issues automatically:

user@host:~/lumigator/lumigator/frontend$ npm run lint:fix

Environment Variables

To configure environment variables, create an .env file in the root of the frontend directory with the following structure:

VUE_APP_BASE_URL=http://localhost:8000/api/v1/  # Backend API URL

You can add other environment-specific variables as needed.