Snnap

Basic System Install

A few tools are needed to be installed for basic development:

• Docker
• NodeJS
• NPM

The webserver (and websockets) run using signed certs on the back end, for a secure connection. On a development machine, this means you'll need to create self-signed certs, which is easiest using openssl. The cert should be named cert.pem and the key should be named key-rsa.pem. These should be generated and stored in the api/certs directory.

Additionally, because websockets connect directly, you might need to tell your browser to accept self-signed certs by enabling this on localhost:

chrome://flags/#allow-insecure-localhost

Deploying Application

Using Docker Compose

You probably want this for testing and prod deployments, not for development use In main directory run:

docker-compose up --build
docker exec -i snnap_mysql ./setup-database.sh

Individual Components

You probably want this for development or testing use, not prod deployments

Database

export $(grep -v '^#' .env | xargs)
cd sql
docker image build . -t snnap_mysql
docker container run --name=snnap_mysql -p ${MYSQL_PORT}:3306 -e MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD} -e MYSQL_USER=${MYSQL_USER} -e MYSQL_PASSWORD=${MYSQL_PASSWORD} -e MYSQL_DATABASE=${MYSQL_DATABASE} snnap_mysql:latest
docker exec -i snnap_mysql ./setup-database.sh

API Server

export $(grep -v '^#' .env | xargs)
cd api
npm install
npm run start

React UI

Create a .env file with local connection information in the ui directory

#ui/.env
REACT_APP_DOMAIN=localhost
REACT_APP_WS_PROTOCOL=ws
REACT_APP_WS_PORT=3001

REACT_APP_GEOAPIFY_API_KEY=[mygeoapifyapikey]

export $(grep -v '^#' .env | xargs)
cd ui
npm install
npm run start

Testing

Unit

Unit tests exist for both the API and the UI. To execute these tests, simply navigate to the folder, and run the test command:

npm install
npm run test

Coverage goals are set to 95%, so even if all tests pass, the execution might fail if desired coverage isn't achieved. With that, not all directories are required for coverage; checkout package.json in each directory to determine what files need coverage.

Integration

Functional

export $(grep -v '^#' .env | xargs)
npm install
npm run test

This defaults to run tests on the port 3000 (hosted by default from React). If you are running the application from docker-compose, or deployed elsewhere, you'll want to change the location that tests run, by providing the APP url.

APP=http://localhost npm run test

DevOps Strategy

Using GitHub actions to manage all automated testing. Currently, each module (api, ui) has a GitHub action that runs on each push. This runs UTs, ITs, along with some linting and security scanning of dependencies. When a PR is opened, the functional tests are executed. These are all set as checks before the code can be merged into main

Documentation

Workflow Design Feedback