saru  by will-lp1

AI writing assistant with integrated web search

Created 6 months ago
276 stars

Top 93.8% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

Saru is a monorepo project aiming to be "The Cursor for Writing," likely an AI-powered writing assistant or editor. It targets users seeking enhanced writing capabilities through modern web technologies and AI integrations, offering a potentially more productive writing experience.

How It Works

The project employs a full-stack architecture built with Next.js (App Router) and TypeScript. It leverages Drizzle ORM with PostgreSQL for data management, Shadcn UI for components, and Better Auth for authentication. Core functionality is enhanced by the Vercel AI SDK, enabling integration with multiple LLM providers, and Tavily for web search capabilities.

Quick Start & Requirements

Setup involves cloning the repository, installing dependencies via pnpm install, and configuring environment variables (.env files) for database connection (DATABASE_URL), authentication (BETTER_AUTH_SECRET, BETTER_AUTH_URL), and AI services (GROQ_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY). A PostgreSQL database is managed via Docker (docker compose up -d). Schema migrations are handled with pnpm db:push. The application runs locally using pnpm dev and is accessible at http://localhost:3000. Prerequisites include Git, Node.js/pnpm, Docker, and API keys for AI services.

Highlighted Details

  • Monorepo structure separating the Next.js app (apps/saru) from database logic (packages/db).
  • Modern frontend stack featuring Next.js App Router, React, and Shadcn UI.
  • Extensive AI integration supporting multiple LLM providers (Groq, OpenAI, Anthropic) via Vercel AI SDK.
  • Built-in web search functionality powered by Tavily.

Maintenance & Community

The provided README does not contain specific details regarding maintainers, community channels (like Discord/Slack), roadmaps, or recent activity.

Licensing & Compatibility

The project is licensed under the Apache License 2.0. This license is permissive, generally allowing for commercial use and integration into closed-source projects without significant copyleft restrictions.

Limitations & Caveats

The README focuses on local development setup and does not detail production deployment, scalability considerations, or performance benchmarks. Setup requires obtaining multiple API keys and running Docker, which may present initial hurdles for users. The project's current status (e.g., alpha, beta) is not explicitly stated.

Health Check
Last Commit

1 week ago

Responsiveness

Inactive

Pull Requests (30d)
9
Issues (30d)
0
Star History
9 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.