Shelob9 / digitial-garden-builder

No code, multi-player digital garden builder.

Home Page:https://docs.digitalgardenbuilder.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Digital Garden Builder

Source for digital garden builder a multi-player writing tool.

This is an experiment Josh made.

Gitpod ready-to-code Tests

Install

  • Clone
    • git clone git@github.com:Shelob9/digital-garden-builder.git
  • Install with Yarn.
    • Do not use npm. Must use Yarn 1.x
    • yarn
    • yarn lerna bootstrap

Development

Workspaces

There are three workspaces. You can run commands in the workspaces by prefixing there name to the command. For example, to install a package in client workspace, you would run yarn client add cross-env or to build the server, you would run yarn server build

  • Client
    • yarn client ...
    • Generates HTML for each digital garden.
  • Server
    • yarn server ...
    • Git API server.
  • Builder
    • The CLI
    • Used to build sites and deploy to Github pages.

Using Workspaces For Development

  • Start server and client
    • yarn dev
  • Start server:
    • yarn server dev
  • Start client:
    • yarn client dev
  • Test server:
    • yarn test server
  • Test client:
    • yarn test client

Release To NPM

yarn lerna publish

The builder is currently the only one being published.

About

No code, multi-player digital garden builder.

https://docs.digitalgardenbuilder.app


Languages

Language:TypeScript 83.9%Language:JavaScript 8.9%Language:CSS 6.9%Language:Dockerfile 0.2%Language:Shell 0.1%