Skip to content
ReArch Docs

Getting Started

ReArch is a platform designed to help engineers rearchitect and modernize their systems. This guide will walk you through the basics of setting up your first project.

Prerequisites

Section titled “Prerequisites”

Before you begin, make sure you have the following installed:

  • Node.js v18 or later
  • Bun v1.0 or later (recommended) or npm
  • A GitHub account for repository integration

Quick Start

Section titled “Quick Start”

1. Create a new project

Section titled “1. Create a new project”
Terminal window
bunx create-rearch my-project

2. Navigate to your project

Section titled “2. Navigate to your project”
Terminal window
cd my-project

3. Install dependencies

Section titled “3. Install dependencies”
Terminal window
bun install

4. Start the development server

Section titled “4. Start the development server”
Terminal window
bun run dev

Your project should now be running at http://localhost:3000.

Project Structure

Section titled “Project Structure”

A newly created ReArch project has the following structure:

my-project/
├── src/
│   ├── agents/
│   ├── pipelines/
│   └── config.ts
├── tests/
├── package.json
└── rearch.config.mjs
DirectoryPurpose
src/agents/Agent definitions and configurations
src/pipelines/Data processing pipelines
src/config.tsMain application configuration
tests/Test files

Next Steps

Section titled “Next Steps”

Now that you have a running project, you can: