Engineering Onboarding

Goal of this document is to kickstart your development of the 🍯Products

Environment prerequisites

💡

You will need Linux or Mac OSX with Docker to develop 📱Web-app services

To develop
👁️‍🗨️Entrance Observer video processing services you’ll need 🎮NVidia Jetson Orin Nano or 🎮NVidia Jetson Nano to have GPU support and docker image compatibility

Local development setup

Start by checking out https://github.com/gratheon/web-app. Its just a react single-page app and does not need a docker image but you can see API dependencies it will require. Checkout its README.md “development” section to run it. You should be able to get to the login page, but since it doesn’t have a backend yet, you won’t be able to login

Next, checkout all of the core dependent services based on the architecture diagram to understand how services on the backend are connected

Core services

The following services are mandatory, you will need to git-checkout them and start in the following order:

mysql ← provides storage for other node and go services

redis ← provides a pub-sub and caching layer

graphql-schema-registry ← stores graphql schema of microservices

graphql-router ← routes API requests to other microservices using a graphql federation, which basically means that requests are split and routed to the microservice that is responsible for particular part of the schema

Product services

go-api ← main service that manages domain entities like apiary, hive, hive section, frame, frame side

image-splitter ← main service that manages image processing + stores data on the detected objects in the frame photo

Note that some service may still be in development and can be unstable or only in draft phase (video processing for example)

After checkout

For every service, you’ll need to run make start to start docker container

For every service, you’ll likely need to set src/config/config.dev.ts that was not commited to the repository. Configs typically include credentials to access DB, AWS S3 or external services

💡

Note that some services run DB migrations when they start-up, so make sure you have mysql running and databases pre-created with valid user access. Note that most services do not yet re-connect to mysql automatically, so you need to start services in correct order or restart pod

Optional services

Some services are not blocking the UI or backend in general, but are required for some specific features, so you may need depending on your work:

models-bee-detector ← detects bees

event-stream-filter ← sends events to frontend

gate-video-stream

models-gate-tracker