https://github.com/srbrahma/bucketline

Bucket your Visual Regression Images!
https://github.com/srbrahma/bucketline

Last synced: about 2 months ago
JSON representation

Bucket your Visual Regression Images!

• Host: GitHub
• URL: https://github.com/srbrahma/bucketline
• Owner: SrBrahma
• Created: 2024-09-07T14:30:42.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-12T11:17:30.000Z (3 months ago)
• Last Synced: 2024-10-12T17:42:11.185Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.01 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        







# Bucketline

[![npm](https://img.shields.io/npm/v/bucketline)](https://www.npmjs.com/package/bucketline) [![npm](https://img.shields.io/npm/dw/bucketline)](https://www.npmjs.com/package/bucketline)



Bucket Storage integration for your Visual Regression CI. Supports Playwright & Storybook and GitHub & GitLab.





Fully free and open-source alternative to Chromatic.






## 🏗️ - WIP! This is not usable yet! - 👷



# ☁️ Cloud Setup

### 1) Setup the File Storage with [Xata](https://xata.io)

[Xata](https://xata.io) is a Cloud service which Free Tier includes a generous **2GB file storage** [on steroids](https://xata.io/docs/sdk/file-attachments).

  1) Sign-in to [Xata](https://xata.io)

  2) Go through the onboarding process until they provide the API keys and copy them. You can skip the remaining steps.

  3) Set these ENVs in your CI settings:

  ```

  BUCKETLINE_DB_API_KEY = 

  BUCKETLINE_DB_URL = 

  ```

### 2) Setup the Frontend with NextJS

  1) Sign-in to https://vercel.com/login

  2) Click to add a new project

  3) Click on the link `Import Third-Party Git Repository` and enter

## 🤖 Development

**For local development of this package**, You need `bun`. Then:

```bash

bun start

```