microboard_test

Online whiteboard

This is a README for the whiteboard project. It contains information about the project, how to get started, and how to contribute.

How to run the app

When you run your development environment using docker-compose up, Docker will use the volume mount to link your local project directory with the one inside the container. When you make changes to your code, Nodemon will detect these changes and restart the Node.js process inside the container, giving you an experience close to developing without containers.

To start development environment:

docker-compose -f docker-compose.dev.yml up --build

How to start development

To install git hooks

npm run prepare

To run tests

To execute the Cucumber Playwright tests

docker-compose -f docker-compose.dev.yml run playwright npm run cucumber:playwright

How to distribute the app

Export the app

docker build -t api:latest -f Dockerfile.export --build-arg INTEGRATION_UI=microboard .
docker create --name temp_container api:latest
docker export temp_container | gzip > api_container.tar.gz
docker rm temp_container

Import the app

docker import api_container.tar.gz api:imported

Create keys

openssl ecparam -genkey -name prime256v1 -noout -out access_private_key.pem
openssl ec -in access_private_key.pem -pubout -out access_public_key.pem
openssl ecparam -genkey -name prime256v1 -noout -out refresh_private_key.pem
openssl ec -in refresh_private_key.pem -pubout -out refresh_public_key.pem

Configure the enviroment

Start the app

docker-compose --verbose -f docker-compose.import.yml up

Check the contents of container

/usr/api

dist
node_modules
package.json
package-lock.json
public .env