CubeServer

Software to manage, store, score, and publish data received by Wifi-equipped microcontrollers for managing a school contest called The Project. A live instance of this may or may not be available at https://whsproject.club/.

Terminology:

CubeServer
- The name of the software backing "The Project" This includes the web application and leaderboard, the admin panel, the team API, and any other software contained within this repository.
Cube
- An individual team's station that will be mounted atop the roof of the school

Configuring email sending with GMail:

Create an App Password

• Go to your Google Account.
• Select Security.
• Under "Signing in to Google," select 2-Step Verification.
• At the bottom of the page, select App passwords.
• Enter a name that helps you remember where you'll use the app password.
• Select Generate.

Configure SMTP via admin

• SMTP Server Address: smtp.gmail.com:587
• SMTP Credentials as user:pass: [gmail email addresss]:[app password]

Versioning:

This project uses Semantic Versioning in the format major.minor.patch Versions 0.0.0 until 1.0.0 are development releases. Version 1.0.0 will be the first production release. A new major or minor version may indicate database incompatibility unless otherwise noted, however patch versions should maintain database compatibility. See CONTRIBUTING.md for more info.

Version	Notes
v0.1.0-alpha	basic web interface & structure demo
v0.1.1-alpha	early API implementation
v0.1.2-alpha	early API improvements
v0.2.0-alpha	preconfigured library packages
v0.3.0-alpha	preconfigured library improvements
v0.4.0-beta	partially functional; basics working
v0.5.0-beta	First Deployable Release
v1.0.0	Version 1.0.0
v1.?.?	Fully-functional Production Release Milestone

Version suffices

Ending	Meaning
-dev	Tracks the development of that release
-beta	Prerelease version

Building/running:

The Easy Way-

Use the Ubuntu install script:

git clone https://github.com/snorklerjoe/CubeServer
cd CubeServer
sudo ./tools/install_ubuntu.sh

This will install a Systemd service for the server and everything will be automatic and work... Unless it doesn't.

Note that this method is now unsupported and will be removed in a future version

---

Using   docker compose build -

Install Docker dependency-

sudo apt install docker-ce docker-ce-cli containerd.io docker-compose-plugin docker-compose

Then use Docker-Compose to build and run:

./configure
docker-compose build
docker-compose up

To permanantly reset the installation to the defaults and erase ALL data, run the following:

docker-compose down && docker volume rm cubeserver_mongodb-data cubeserver_api-ssl-cert cubeserver_flask-secret

Cross-building and Docker Hub

Containers are built on Docker Hub for arm64 and amd64 linux (moving forward)

docker buildx bake -f docker-compose.yml -f .env --set *.platform=linux/arm64,linux/amd64

Thus, the latest version can also be installed for arm64 and amd64:

./configure
docker compose pull

Note: This relies upon MongoDB, which no longer officially supports binaries for ARM architectures below 8.2. Thus, for arm64v8 systems, a community build of MongoDB is substituted. See #60 for more information

Topology & Docker Containers

CubeServer is built upon the containerization platform Docker. As described in docker-compose.yml, CubeServer is essentially comprised of the following parts as Docker containers:

• CubeServer-app
  • The web app, served by GUnicorn and Flask.
• CubeServer-api
  • The API for Cubes, also served by GUnicorn and Flask
• CubeServer-mongodb
  • A standalone MongoDB server, central to the other containers
• CubeServer-accesspoint
  • The container from which the WiFi access point and routing is taken care of to allow Cubes to connect to the API.

Files used for building each of these containers (other than CubeServer-mongodb, which is prebuilt) may be found in Docker/.

Customization:

The rules and workings of the "game" may be customized and/or modified as described in CUSTOMIZATION.md.

Todos:

CubeServer development is tracked by this GitHub Project