Skip to content

matt-de-young/preflight

Repository files navigation

Preflight

Preflight automates the more tedious parts of a standup & promotes good habits for the rest. It designed to streamline daily standup meetings by generating reports and summaries of ongoing tasks and issues. It integrates with Linear to find out what the team is working on, OpenAI to summarize it, & Slack for reporting.

Usage

This project runs a task either on a schedule or when triggered that will gather info about any active Linear issues, summarize them, & post a report to Slack.

Reports will include any teams that the LINEAR_API_KEY has permissions to read & works with teams using cycles or not.

This tool has a web interface, but reports are not available to view as it does not include any authentication.

Generating Reports

Standup reports can be generated in a few different ways:

  • Automatically at 6:00 UTC on weekdays
  • From the web interface
  • From the CLI with deno task generate-standup
  • By making a GET request to the endpoint https://fresh.deno.dev/api/standup

Development

Make sure to install Deno.

Then start the project:

deno task start

This will watch the project directory and restart as necessary.

Environment Variables

The following environment variables are required for the application to run:

  • LINEAR_API_KEY: API key for Linear.
  • SLACK_WEBHOOK_URL: Webhook URL for Slack.
  • OPENAI_API_KEY: API key for OpenAI.

You can set these variables in a .env file in the root directory.

Building

The web interface uses Fresh which is an optimized server side framework & must be built during deployment. This can also be done with deno task build.

Formating

deno fmt can be used to automatically format all code.

Linting

deno task check will lint all files & check for errors or warnings.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the [LICENSE] file for details.

About

Automated standup assistant

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published