Skip to content

Latest commit

 

History

History

app

README.md

MumbleBee Application

MumbleBee is a single page application (SPA) built with Vue 3. This project was initialized with Vite.

Prerequisites

You need Node.js v16 or later installed.

Resolving dependencies

npm ci

Preparing configuration files for the Mumble server

You have to prepare the following files:

These files are never committed to this repository because they contain information specific to your environment.

src/configs/api-config.ts

You can find an example at src/configs/api-config.example.ts.

src/configs/auth-config.ts

You can find an example at src/configs/auth-config.example.ts.

You also have to make sure that the URL of your MumbleBee app is registered as a callback URL for the Mumble authenticator (AWS Cognito user pool client). Please refer to the Mumble CDK documentation for how to configure it.

Generating configuration files

If you have deployed and configured the Mumble server following the instructions in the Mumble CDK documentation, you can generate the configuration files with the configure npm script. You have to set the AWS_PROFILE environment variable before running the script.

For development:

npm run configure -- development

For production:

npm run configure -- production

Building for production

You have to make sure the configuration files are properly configured before building for production. There is a helper npm script build:release to make sure the configuration files are auto-generated before building for production. You have to set the AWS_PROFILE environment variable before running the script.

npm run build:release

Hosting MumbleBee

You may host your MumbleBee app on whatever platform you like. But, in the /cdk folder, you can find an AWS Cloud Development Kit (CDK) stack that provisions necessary resources to deliver the app via Amazon S3 + Amazon CloudFront.

Vite scripts

The following Vite scripts are also available.

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Please use build:release to make sure that configuration files are suited for production.

Run Unit Tests with Vitest

Unit tests are not implemented yet.

npm run test:unit

Run End-to-End Tests with Cypress

End-to-end tests are not implemented yet.

npm run test:e2e:dev

This runs the end-to-end tests against the Vite development server. It is much faster than the production build.

But it's still recommended to test the production build with test:e2e before deploying (e.g. in CI environments):

npm run build
npm run test:e2e

Lint with ESLint

npm run lint