TinyToast 🍞

Small checks. Better pull requests.

TinyToast is a lightweight GitHub App designed to help developers catch issues in pull requests before merging.

It automatically checks pull request activity and reports validation results directly on GitHub.

Features

• GitHub App integration
• Automatic pull request event detection
• Pull request validation
• GitHub Check Run reporting
• Clear pass/fail results

How It Works

1. A developer opens or updates a pull request.
2. GitHub sends a webhook event to TinyToast.
3. TinyToast processes the event and performs its checks.
4. Results are reported back to GitHub.
5. Developers can review the result before merging.

Project Status

Early Development

TinyToast is currently under development. The initial focus is on webhook integration, pull request detection, and basic validation.

Technology Stack

• Node.js
• Express.js
• GitHub Apps API
• GitHub Webhooks
• Render

Development

Clone the repository:

git clone https://github.com/edgeroboticsstudio/TinyToast.git
cd TinyToast

Install dependencies:

npm install

Create a .env file:

PORT=10000
WEBHOOK_SECRET=your_webhook_secret
APP_ID=your_github_app_id
PRIVATE_KEY=your_github_app_private_key

Start the application:

npm start

Project Vision

Keep pull request checks simple, useful, and accessible to every developer.

---

Developed by Edge Robotics Studio.