Skip to content

SaarthakSinghal/beetroot-docs

Repository files navigation

Beetroot - Docs

This repository contains the documentation source code for the Beetroot project.

Beetroot is an AWS-based photo system that:

  • detects faces using Amazon Rekognition
  • groups faces into People (using Rekognition Collections)
  • stores relationships in DynamoDB (Persons, Occurrences, Photos)
  • exposes a small HTTP API (API Gateway → Lambda) for the React frontend
  • serves images securely using pre-signed S3 URLs

What’s inside

  • Docs site source (Fumadocs)
  • Step-by-step chapters for the backend build (S3 → Lambda → Rekognition → DynamoDB → API)
  • Notes on IAM least-privilege, common mistakes, and debugging checkpoints
  • Dynamic Open Graph images for docs pages, generated from each page title and description
  • A small docs sidebar notice for the Keep Android Open campaign

Local setup

  1. Install dependencies
bun install
  1. Start the docs site
bun run dev
  1. Build for production
bun run build
bun run start

Requirements

  • Node.js 18+ (recommended)
  • Bun

Related repos

Credits

About

Source code for the documentation of project beetroot

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors