Ondsel-Server

Getting Started

Clone the repository with submodules

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

Installation

You can install Ondsel-Server in two ways:

Using docker-compose (Recommended, only requires Docker)
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: admin@local.test
Password: admin@local.test

Frontend Application

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 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

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 frontend dependencies npm ci
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
$ npm run dev

Running FC-Worker

Clone FC-Worker repository.
Build docker image (docker build -t fc-worker .)
Run docker image (docker run -p 9000:8080 --name fc_worker fc-worker:latest)

$ git clone git@github.com:FreeCAD/FC-Worker.git
$ cd FC-Worker
$ docker build -t fc-worker .
$ docker run -p 9000:8080 --name fc_worker fc-worker:latest

FreeCAD/Ondsel-Server

ErrorLooks like something went wrong!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages