CodePair

Build your own AI real-time collaborative markdown editor in just 5 minutes.

Website • Discord

Overview

CodePair is an open-source real-time collaborative markdown editor with AI intelligence, built using React, NestJS, and LangChain.

CodePair provides the following features:

• Workspace: A space where users can invite others and collaboratively edit documents
• Sharing Document: Share documents with external parties by setting permissions and expiration time
• Yorkie Intelligence: AI intelligence available within the collaborative editing editor

Packages

This repository contains multiple packages/modules that make up our project. Each package/module is contained in its own directory within this repository.

• Frontend: Contains the frontend code of our application. Please refer to frontend/README.md for detailed information on setting up and running the frontend.
• Backend: Contains the backend code of our application. Please refer to backend/README.md for detailed information on setting up and running the backend.

Getting Started with Development

Configuration and Setup

Before running the Frontend and Backend applications, you need to fill in the required API Keys.
Follow these steps:

Frontend Environment Configuration

1. Navigate to the frontend directory.

   cd frontend

2. Copy the .env.example file to create a .env.development file.

   cp .env.example .env.development

3. Edit the .env.development file and fill in the necessary environment variable values. Refer to the comments for the meaning and examples of each value.

Backend Environment Configuration

1. Navigate to the frontend directory.

   cd backend

2. Copy the .env.example file to create a .env.development file.

   cp .env.example .env.development

3. Edit the .env.development file and fill in the necessary environment variable values. Refer to the comments for the meaning and examples of each value.

Run Application

1. Run the Dockerfile for MongoDB, the database used by CodePair:

   docker-compose up -f ./backend/docker/mongodb_replica/docker-compose.yml -d

2. Run the Backend application:

   cd backend
   npm install
   npm run start:dev

3. Run the Frontend application:

   cd frontend
   npm install
   npm run dev

4. Visit http://localhost:5173 to enjoy your CodePair.

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Contributors ✨

Thanks goes to these incredible people: