FreeCAD/Ondsel-Server

web platform which mainly contains frontend and backend for Ondsel Service

Ondsel-Server

Getting Started

Clone the repository with submodules

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

Installation

You can install Ondsel-Server 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

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

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

• URL: http://localhost:3000
• Email: admin@local.test
• Password: admin@local.test

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 to .env (Or export variables)
• Install frontend dependencies npm ci
• Finally, run server npm run dev

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

Running FC-Worker

• Clone FC-Woker 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:Ondsel-Development/FC-Worker.git
$ cd FC-Worker
$ docker build -t fc-worker .
$ docker run -p 9000:8080 --name fc_worker fc-worker:latest

Important Links

• DEV
  • Frontend: http://ec2-54-234-132-150.compute-1.amazonaws.com:8080/
  • Backend API: http://ec2-54-234-132-150.compute-1.amazonaws.com/
  • API docs: http://ec2-54-234-132-150.compute-1.amazonaws.com/docs/
• Production
  • Frontend: https://lens.ondsel.com/
  • Backend API: https://lens-api.ondsel.com/
  • API docs: https://lens-api.ondsel.com/docs/

Deployment

Deployment to PROD

1. Merge code to production branch.
2. Now, create a zip file of backend and frontend source code. Run following commands:
   1. git fetch origin
   2. git checkout origin/production
   3. cd backend
   4. zip -r ./od-backend.zip .
   5. cd ../frontend
   6. add the .env file that you have
   7. zip -r ./od-frontend.zip .
3. Login to AWS dashboard (https://console.aws.amazon.com/console/home).
4. Open Elastic Beanstalk app (https://us-east-1.console.aws.amazon.com/elasticbeanstalk/home?region=us-east-1#/environments)
5. Deploying backend service (https://lens-api.ondsel.com/).
   1. Open od-backend-prod-app-env environment.
   2. Click on Upload and deploy button.
   3. This will open a dialog to upload ZIP.
   4. Upload od-backend.zip file and in Version label put commit hash (i.e d7fb86244117efb679edd0bb41bedf230cb2fc19)
   5. This will deploy backend service (https://lens-api.ondsel.com/)
6. Deploying frontend service (https://lens.ondsel.com/).
   1. Open od-frontend-prod-app-env environment.
   2. Click on Upload and deploy button.
   3. This will open a dialog to upload ZIP.
   4. Upload od-frontend.zip file and in Version label put commit hash (i.e d7fb86244117efb679edd0bb41bedf230cb2fc19)

Running migration on PROD

1. Login to AWS dashboard and open EC2 page.
2. Open od-backend-prod-app-env instance page.
3. Click on Connect to Instance button.

[root@ip-172-31-26-128 ~]# docker ps
CONTAINER ID   IMAGE          COMMAND                  CREATED       STATUS       PORTS      NAMES
9987508aaaa4   9bd321c31a70   "docker-entrypoint.s…"   4 hours ago   Up 4 hours   3030/tcp   vigorous_dirac
[root@ip-172-31-26-128 ~]# docker exec -it 9987508aaaa4 /bin/sh
/app # npm run migration <migration_name> > <migration_name>.logs
/app # exit
[root@ip-172-31-26-128 ~]# exit