https://github.com/hunkim98/toonie

Real-time design blueprint review editor
https://github.com/hunkim98/toonie

crdt hacktoberfest yorkie yorkie-js-sdk

Last synced: about 2 months ago
JSON representation

Real-time design blueprint review editor

• Host: GitHub
• URL: https://github.com/hunkim98/toonie
• Owner: hunkim98
• License: apache-2.0
• Created: 2022-07-29T02:44:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-21T13:21:54.000Z (over 2 years ago)
• Last Synced: 2024-11-07T14:42:37.343Z (4 months ago)
• Topics: crdt, hacktoberfest, yorkie, yorkie-js-sdk
• Language: TypeScript
• Homepage: https://toonie.yorkie.dev
• Size: 7.86 MB
• Stars: 18
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Toonie,

This is a collaborative app for revising image blueprints together

## Developing Toonie

For building Toonie, You'll first need Node.js installed(Node.js version 16+ and npm version 7.10+ are required).

Toonie requires local applications such as Envoy, Yorkie. To start them:

```

docker-compose -f docker/docker-compose.yml up --build -d

```

Next, Let's starts Toonie in the development mode.

```

$ yarn

$ yarn start

```

## Deploying

When PR is merged into main, it is automatically distributed by GitHub Actions.

### Layout

Toonie is deployed to AWS and the configuration is shown below. This repository is used to distribute static pages.

```

[Route53]

 ㄴ toonie.yorkie.dev - [gh-pages] # for serving static pages

 ㄴ api.yorkie.dev      - [EKS]      # for serving API

```