Elaborate

A hosting, version control service of documents.

Description

Elaborate is created by diverting the idea of Git into document development. It enables to host their documents centralizedly and to control their versions. In the progress is enabling you to collaborate on the same documents simultaneously and without overriding each other’s work. This application is for not only writers and coders but everyone who'd like to "elaborate" their documents.

Demo

TODO: β版完成時にここにDemoのgifを貼る.

Requirement

• React 16.8+
• Redux 4.0+
• Webpack 4.29+
• Typescript 3.4+
• Firebase 5.9+

Set up

.env

Firebase config keys like below are required. But the config keys are NOT currently published. Please contact the author to get the keys.

FIREBASE_API_KEY=
FIREBASE_AUTH_ADMIN=
FIREBASE_DATABASE_URL=
FIREBASE_PROJECT_ID=
FIREBASE_STORAGE_BUCKET=
FIREBASE_MESSAGING_SENDER_ID=

building

以下のどちらかを行ったのち、http://localhost:8080 にアクセス

• with docker(recommended)

# https://hub.docker.com/search/?offering=community&type=edition で予めDockerのインストールをしておく
$ git clone git@github.com:bokusunny/elaborate.git

$ docker-compose build # 初回のみ
$ docker-compose up # 自動でjsがビルドされる

# ターミナルで別タブ開き以下を実行
$ docker exec elaborate node -v # v10.15.3と表示されたら成功

# FYI: stop docker container
$ docker stop elaborate

• without docker

$ git clone git@github.com:bokusunny/elaborate.git
$ npm install
$ npm run watch

Author

• Shota Yamazaki
• Taishi Murakami

Content Strategist

• Yuta Tsurusaki