Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 752 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 752 Bytes

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, 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:netlify

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