doit

command module
v0.0.0-...-8dd3885 Latest Latest
Warning

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

Go to latest
Published: Dec 10, 2022 License: Apache-2.0 Imports: 1 Imported by: 0

README

= Shared TODO
:toc:

I'm using this project to play around with writing services in go-lang.

== Overview

Shared TODO allows multiple users to create task lists and share them with
others. Each user has one list and may grant other users view-only or edit
access to it.

A task list is private to its creator unless explicitly shared with someone
else.

A task may be marked private so users other than the task owner may not view or
edit it even if the owner's task list is shared.

A task may be assigned to someone even if the task list isn't shared. Users can
view and edit tasks they own and tasks to which they are assigned.

Tasks can have comments and annotations.

A user logs into the application using an OAuth2 flow.

A user manages tasks from the command line.

== Components
- CLI for user interaction (https://github.com/rivo/tview[tview], might look at others)
- REST server (resource server) for tasks and sharing (https://github.com/go-chi/chi[go-chi])
- SQL Database to store tasks (https://gorm.io[gorm])
- OAuth2/OIDC authorization server (https://www.keycloak.org/[Keycloak])

== Operational Features
- Metrics to enable SLOs, alerts, and dashboards (https://prometheus.io/[Prometheus], https://grafana.com/[Grafana])
- Audit logging
- Searchable logs (https://grafana.com/oss/loki/[Grafana Loki])

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
add
cli
pkg
server/routes
Here we setup the REST handler for the service using chi.
Here we setup the REST handler for the service using chi.
set
tui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL