Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
devleejb committed Feb 2, 2024
1 parent 0a20f0d commit af3b0a5
Showing 1 changed file with 24 additions and 17 deletions.
41 changes: 24 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,38 @@ CodePair is an open-source real-time collaborative markdown editor with AI intel

CodePair provides the following features:

- **Workspace**: A space where users can invite others and collaboratively edit documents.
- **Sharing**: Document sharing with support for permissions and expiration time settings.
- **Yorkie Intelligence**: AI intelligence available within the collaborative editing editor.
- **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

## Getting Started (Development Mode)


1. Run the Dockerfile for MongoDB, the database used by CodePair:
```
docker-compose up -f ./backend/docker/mongodb_replica/docker-compose.yml
```
```
docker-compose up -f ./backend/docker/mongodb_replica/docker-compose.yml
```
2. Run the Backend application:
```
cd backend
npm install
npm run start:dev
```
```
cd backend
npm install
npm run start:dev
```
3. Run the Frontend application:
```
cd frontend
npm install
npm run dev
```
```
cd frontend
npm install
npm run dev
```
4. Visit http://localhost:5173 to enjoy your CodePair experience.
4. Visit http://localhost:5173 to enjoy your CodePair.
## Contributors ✨
Thanks goes to these incredible people:
<a href="https://github.com/yorkie-team/codepair/graphs/contributors">
<img src="https://contrib.rocks/image?repo=yorkie-team/codepair-poc" />
</a>

0 comments on commit af3b0a5

Please sign in to comment.