Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (49 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

68 lines (49 loc) · 1.67 KB
Raw

Contributing

Local development

  1. Clone the repository using your preferred method:

    # HTTPS
git clone https://github.com/lumen-notes/lumen.git

# SSH
git clone git@github.com:lumen-notes/lumen.git

# GitHub CLI
gh repo clone lumen-notes/lumen

  2. Generate a GitHub personal access token (classic) with repo, gist, and user:email scopes, or a fine-grained personal access token scoped to a specific repository with the additional read-only email scope and gist, then add it to a .env.local file in the root directory:

    VITE_GITHUB_PAT=<your token here>

  3. Install the dependencies:

    npm install

  4. Start the development server:

    npm run dev:vercel

  5. Open the app at http://localhost:8888

Architecture

GitHub sync

graph
    subgraph local[Local machine]
      subgraph app.uselumen.com
        state-machine([state machine])
        isomorphic-git[isomorphic-git]
        lightning-fs[lightning-fs]
      end

      local-storage[(localStorage)]
      indexeddb[(IndexedDB)]
    end

    subgraph edge[Vercel Functions]
      cors-proxy(["/cors-proxy"])
    end

    github.com([github.com])

    state-machine <--> isomorphic-git
    state-machine <--> lightning-fs
    state-machine <--> local-storage
    isomorphic-git <--> lightning-fs
    isomorphic-git <--> cors-proxy
    lightning-fs <--> indexeddb
    cors-proxy <--> github.com
Loading