Lens Platform

Getting Started

Clone the repository with submodules

git clone --recurse-submodules https://github.com/FreeCAD/Ondsel-Server.git Lens
cd Lens

Installation

You can install Lens in two ways:

1. Using docker-compose (Recommended, only requires Docker)
2. Manual installation (Requires all dependencies)

Prerequisites for docker-compose

• Install Docker (https://docs.docker.com/engine/install/)

Prerequisites for manual installation

• Install MongoDB (https://www.mongodb.com/docs/manual/installation/)
• Install NodeJS (https://nodejs.org/en/download)
• Install Docker (needed for FC-Worker)

Using docker-compose (Recommended)

This is the easiest way to run the entire application stack.

Create environment file:

cp env.example .env
# or for using AWS S3 for storage:
cp env.with-aws.example .env

Start the server:

# With analytics (recommended):
docker-compose --profile matomo-enabled up --build -d

# Without analytics:
docker-compose up --build -d

# Rebuild the frontend on env change:
docker-compose build --no-cache frontend

# For development:
docker-compose -f docker-compose.dev.yml --profile matomo-enabled up --build -d

# To use prebuild docker images
docker-compose -f docker-compose.prebuilds.yml --profile matomo-enabled up --build -d

That's it! The application should now be running at http://localhost:3000

Default Credentials

Matomo Analytics

• URL: http://localhost:7000
• Username: admin
• Email: [email protected]
• Password: [email protected]

Frontend Application

• URL: http://localhost:3000
• Email: [email protected]
• Password: [email protected]

These credentials can be customized using environment variables in the .env file.

Note: For production environments, it's strongly recommended to change these default credentials using environment variables.

Manual Installation

Running MongoDB

• Install MongoDB
• Start the MongoDB service: systemctl start mongodb
• If necessary, remove an old database: od-backend-db, for example using MongoDB Compass

Running frontend

• Go to the frontend directory
• Rename env.example to .env (Or export variables)
• Install frontend dependencies npm ci
• Finally, run server npm run dev

$ cd frontend
$ mv env.example .env
$ set -a; . ./.env; set +a
$ npm ci
$ npm run dev

To run from Docker, recompile with:

sudo docker build -t frontend .

and run (or re-run) with:

sudo docker run --env-file .env -p 80:80 --rm --name frontend frontend:latest

If it is required to make the server accessible on the local network, change the environment variable below in .env and use the hostname or IP address where the backend is available.

VITE_APP_API_URL=http://<host-or-ip-of-backend>:3030/

Then run the frontend with:

npm run dev -- --host 0.0.0.0

Running backend

• Go to the backend directory
• Rename env.example or env.with-aws.example (for using AWS S3 for storage) to .env (Or export variables)
• Install backend dependencies npm ci
• Run the required migrations (see below)
• Finally, run server npm run dev

$ cd backend
$ mv env.example .env # or `mv env.with-aws.example .env` for using AWS S3 for storage
$ set -a; . ./.env; set +a
$ npm ci

Running Migrations

When running the backend for the first time, you need to run migrations to set up the database. These are automatically handled by entry.sh when using docker-compose, but must be run manually otherwise.

npm run migration addInitialTosPp                # Creates placeholder Terms of Service and Privacy Policy
npm run migration createDefaultSiteConfig        # Creates default site configuration for branding
npm run migration addDefaultAdminUser            # Creates admin user (email: [email protected], password: [email protected])
npm run migration createDefaultPublisherEntries  # Creates publisher entries for software releases page

Then start the server:

npm run dev

Running FC-Worker

The FC-Worker is a submodule and has its own repository.

• Go to the FC-Worker directory
• Build the docker image (docker-compose build)
• Run the docker image (docker-compose up -d)

$ cd FC-Worker
$ docker-compose build
$ docker-compose up -d`

Check if it works:

curl -v http://127.0.0.1:9000/2015-03-31/functions/function/invocations -X POST -H "Content-Type: application/json" -d '{"command":"<your-health-check-string>"}'