scrumdinger

module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 6, 2024 License: Apache-2.0

README

🔥 Helps teams manage their daily scrums.

Table of Contents

📼 Demo

scrumdinger_demo.webm

🔔 About

Many software engineering teams use daily meetings, known as scrums, to plan their work for the day. Scrums are short meetings where each attendee discusses what they accomplished yesterday, what they are working on today, and any obstacles that might impact their work.

⭐ Inspiration

Scrumdinger originally is an iOS tutorial used to teach people the basics of SwiftUI.

🚀 Goals

  • Create a web service using OpenAPI Specification.
  • Create a responsive web app that can be used on desktop and mobile.
  • Using a machine learning model, provide a way for users to transcribe recorded meetings.
  • Provide a Helm chart for easy deployment to Kubernetes.

📦 Monorepo


📦 Scrumdinger
 ┣ 📂api
 ┃ ┣ 📂frontends // All frontend code
 ┃ ┃ ┣ 📂...
 ┃ ┣ 📂services // All web service code
 ┃ ┃ ┣ 📂...
 ┣ 📂app // web controllers and routes for web services
 ┃ ┃ ┣ 📂...
 ┣ 📂business // Business logic 
 ┃ ┃ ┣ 📂...
 ┣ 📂foundation // Common Go code for web services
 ┃ ┃ ┣ 📂...
 ┣ 📂zarf // Deployment files

🚧 Prerequisites

Docker

I recommend installing docker in rootless mode. Also install docker compose.

Go

Download and follow these install instructions.

Node

Download nvm and follow the instructions to install.

🔬 Environments

Development

Run make build and make compose-up

Navigate to the web app and run npm install && npm run dev. The test email is admin@example.com and the password is gophers.

Directories

Path Synopsis
api
services/auth
services/auth/build/all
Package all binds all the routes into the specified app.
 Package all binds all the routes into the specified app.
services/metrics
services/metrics/collector
Package collector is a simple collector for
 Package collector is a simple collector for
services/metrics/publisher
Package publisher manages the publishing of metrics.
 Package publisher manages the publishing of metrics.
services/metrics/publisher/datadog
Package datadog provides support for publishing metrics to DD.
 Package datadog provides support for publishing metrics to DD.
services/metrics/publisher/expvar
Package expvar manages the publishing of metrics to stdout.
 Package expvar manages the publishing of metrics to stdout.
services/metrics/publisher/prometheus
Package prometheus provides suppoert for sending metrics to prometheus.
 Package prometheus provides suppoert for sending metrics to prometheus.
services/scrumdinger
services/scrumdinger/build/all
Package all binds all the routes into the specified app.
 Package all binds all the routes into the specified app.
services/scrumdinger/build/crud
Package crud binds the crud domain set of routes into the specified app.
 Package crud binds the crud domain set of routes into the specified app.
services/scrumdinger/build/reporting
Package reporting binds the reporting domain set of routes into the specified app.
 Package reporting binds the reporting domain set of routes into the specified app.
tooling/admin
This program performs administrative tasks for the garage sale service.
 This program performs administrative tasks for the garage sale service.
tooling/admin/commands
Package commands contains the functionality for the set of commands currently supported by the CLI tooling.
 Package commands contains the functionality for the set of commands currently supported by the CLI tooling.
tooling/logfmt
This program takes the structured log output and makes it readable.
 This program takes the structured log output and makes it readable.
app
domain/authapp
Package authapp maintains the web based api for auth access.
 Package authapp maintains the web based api for auth access.
domain/checkapp
Package checkapp maintains the app layer api for the check domain.
 Package checkapp maintains the app layer api for the check domain.
domain/scrumapp
Package scrumapp maintains the app layer api for the scrum domain.
 Package scrumapp maintains the app layer api for the scrum domain.
domain/userapp
Package userapp maintains the app layer api for the user domain.
 Package userapp maintains the app layer api for the user domain.
sdk/apitest
Package apitest provides support for excuting api test logic.
 Package apitest provides support for excuting api test logic.
sdk/auth
Package auth provides authentication and authorization support.
 Package auth provides authentication and authorization support.
sdk/authclient
Package authclient provides support to access the auth service.
 Package authclient provides support to access the auth service.
sdk/debug
Package debug provides handler support for the debugging endpoints.
 Package debug provides handler support for the debugging endpoints.
sdk/errs
Package errs provides types and support related to web error functionality.
 Package errs provides types and support related to web error functionality.
sdk/metrics
Package metrics constructs the metrics the application will track.
 Package metrics constructs the metrics the application will track.
sdk/mid
Package mid provides app level middleware support.
 Package mid provides app level middleware support.
sdk/mux
Package mux provides support to bind domain level routes to the application mux.
 Package mux provides support to bind domain level routes to the application mux.
sdk/query
Package query provides support for query paging.
 Package query provides support for query paging.
business
domain/scrumbus
Package scrumbus provides business access to scrum domain.
 Package scrumbus provides business access to scrum domain.
domain/scrumbus/stores/scrumdb
Package scrumdb contains scrum related CRUD functionality.
 Package scrumdb contains scrum related CRUD functionality.
domain/userbus
Package userbus provides business access to user domain.
 Package userbus provides business access to user domain.
domain/userbus/stores/usercache
Package usercache contains user related CRUD functionality with caching.
 Package usercache contains user related CRUD functionality with caching.
domain/userbus/stores/userdb
Package userdb contains user related CRUD functionality.
 Package userdb contains user related CRUD functionality.
sdk/dbtest
Package dbtest contains supporting code for running tests that hit the DB.
 Package dbtest contains supporting code for running tests that hit the DB.
sdk/delegate
Package delegate provides the ability to make function calls between different domain packages when an import is not possible.
 Package delegate provides the ability to make function calls between different domain packages when an import is not possible.
sdk/migrate
Package migrate contains the database schema, migrations and seeding data.
 Package migrate contains the database schema, migrations and seeding data.
sdk/order
Package order provides support for describing the ordering of data.
 Package order provides support for describing the ordering of data.
sdk/page
Package page provides support for query paging.
 Package page provides support for query paging.
sdk/sqldb
Package sqldb provides support for access the database.
 Package sqldb provides support for access the database.
sdk/sqldb/dbarray
Package dbarray provides support for database array types.
 Package dbarray provides support for database array types.
sdk/unitest
Package unitest provides support for excuting unit test logic.
 Package unitest provides support for excuting unit test logic.
types/money
Package money represents a money in the system.
 Package money represents a money in the system.
types/name
Package name represents a name in the system.
 Package name represents a name in the system.
types/quantity
Package quantity represents a quantity in the system.
 Package quantity represents a quantity in the system.
types/role
Package role represents the role type in the system.
 Package role represents the role type in the system.
foundation
docker
Package docker provides support for starting and stopping docker containers for running tests.
 Package docker provides support for starting and stopping docker containers for running tests.
keystore
Package keystore implements the auth.KeyLookup interface.
 Package keystore implements the auth.KeyLookup interface.
logger
Package logger provides support for initializing the log system.
 Package logger provides support for initializing the log system.
otel
Package otel provides otel support.
 Package otel provides otel support.
web
Package web contains a small web framework extension.
 Package web contains a small web framework extension.
worker
Package worker manages a set of registered jobs that execute on demand.
 Package worker manages a set of registered jobs that execute on demand.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.