Shatzën Scrum Poker

Shatzën is a Scrum poker app that allows distributed teams to run Scrum poker estimation sessions with ease.

• Shatzën Scrum Poker
  • Develop
  • Environment setup
    • MongoDB
      • Connect to MongoDB
  • Adding dependencies
  • Commits

Develop

For full-stack development:

npm run dev

Environment setup

1. Install dependencies for all packages: npm install
2. Initialize default .env files: npm run init-env
3. Install and start up the MongoDB service

MongoDB

To install mongoDB instance please follow these instructions

To run MongoDB (i.e. the mongod process) as a macOS service, run:

brew services start mongodb-community@6.0

To stop a mongod running as a macOS service, use the following command as needed:

brew services stop mongodb-community@6.0

Connect to MongoDB

To begin using MongoDB, connect mongosh to the running instance. From a new terminal, issue the following:

mongosh

Adding dependencies

npm install <package name> -w=<workspace to install in>

npm update <package> --workspace=<workspace>

Commits

Commits and PR's are linted with the Conventional Commits spec

Structure

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Examples

feat(scope): Commit message with scope

docs: Commit message with no body

feat!: Commit message with scope and ! to draw attention to breaking change

BREAKING CHANGE: omg everything is on fire