ceretro v0.2.1

Ceretro - Live Sprint Retro App

Ceretro is a live-editing app for Sprint Retrospectives.

Usage

To use Ceretro, you'll need a DB with a migrations table with the following schema:

CREATE TABLE `migrations` (
  `file` VARCHAR(255) NOT NULL,
  `created` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`file`));

Then, to run Ceretro, simply import and call Ceretro with mysql credentials and a user method to retrieve the User based on the Express Request/Response.

import { Ceretro } from "ceretro"

Ceretro({
  admins: {
    groups: ["some group"],
    users: ["some user id"],
  },

  mysql: {
    database: "<SOME_DB>",
    host: "<SOME_HOST>",
    password: "<SOME_PASSWORD>",
    user: "<SOME_USER>",
  },

  user: (req: Request, res: Response) =>
    Promise.resolve({ id: "some_id" }),
})

Development

First you'll need to build and run the Ceretro backend:

npm run server:build
npm run server:run

Then you can start the frontend development server

PROXY_HOST="http://<HOST>:23720" npm run client:watch