Getting Started

To get OpenEdit up and running on your local machine, follow these steps:

Prerequisites

Ensure you have the following installed:

• Bun: A fast JavaScript runtime, package manager, bundler, and test runner.
  • Installation Guide

Setup

1. Clone the repository:

   git clone https://github.com/just-moh-it/openedit.git
   cd openedit

2. Install dependencies:

   bun install

3. Change directory:

   cd apps/web

4. Setup database:

We use Drizzle ORM for database migrations and a postgres-compatible database schema for our database. Please use supabase or connect to a local postgres database and keep the connection url for the next step.

5. Setup environment variables:

   cp .env.example .env

If you're still facing issues, please refer to server-env.ts and client-env.ts to see the required environment variables.

6. Run the database migrations:

   bun db:migrate

7. Run the development server:

   bun dev 

The web application will be accessible at http://localhost:3001.

Tech Stack

• TypeScript - For type safety and improved developer experience
• TanStack Start - SSR framework with TanStack Router
• TailwindCSS - Utility-first CSS for rapid UI development
• shadcn/ui - Reusable UI components
• Node.js - Runtime environment
• Turborepo - Optimized monorepo build system
• Biome - Linting and formatting
• Husky - Git hooks for code quality

Features

WIP.

Roadmap

WIP.

Contributing

Please see CONTRIBUTING.md for details on how to contribute to this project.