Minimum Viable Ceremonies

This is an app designed to help teams improve their agile processes, a part of https://minimal.cards. This repo is live at https://mvc.minimal.cards.

It's written on the excellent Gatsby framework, with a Firebase backend.

⚖️ License.

Minimum Viable Ceremonies is an open source project under the GNU AGPL 3.0 license.

🔧 Developing.

gatsby develop

NB that in order to connect to the database you'll need two ENV variables set:

export MVC_FIREBASE_API_KEY="<api_key>"
export MVC_FIREBASE_DOMAIN="<domain>"

🔬 Testing.

We use Cypress to run end to end tests on our code.

npm run test

or, to run inline in the terminal:

npm run test:ci

🚀 Building for production.

gatsby build

💫 Deploying.

Pushing to the master branch of this repo will automatically publish to firebase:

https://mvc.minimal.cards/

👀 Analytics

In order to enable Matomo for analytics in development (for example to test out some new analytics functionality), create an .env.development file, with the following values:

MATOMO_URL=https://stats.minimal.cards/piwik/
MATOMO_SITE_ID=1

To view the analytics coming through, visit the analytics dashboard and ensure you're viewing the Minimum Viable Ceremonies (dev) site.

💬 LiveChat

To view the Freshchat widget, put the following into an .env.development file:

FRESHCHAT_TOKEN=<API_TOKEN>
FRESHCHAT_HOST=https://wchat.au.freshchat.com

📖 Translating

Visit our translation page to translate Minimum Viable Ceremonies into your language!

In order to publish or sync translations, you'll need to set an API key for Crowdin:

CROWDIN_API_KEY=<API_TOKEN>