Document repo split, desktop API URL, and env template#52
Merged
Conversation
Copilot created this pull request from a session on behalf of
sanks011
May 27, 2026 09:06
View session
There was a problem hiding this comment.
Pull request overview
This PR is documentation-only: it updates the README to clarify that this repo is the web/server app, points to a companion Electron repo, documents how to configure the desktop app's VITE_API_URL, simplifies the environment variable section to point at a new .env.example, and adds contributor guidance to open a discussion before large features.
Changes:
- Adds a "Repositories & Sync" section explaining the web/server vs desktop repos and recommended folder layout.
- Replaces the inline annotated env block with a condensed list aligned to
.env.exampleand adds a local-dev note. - Updates Contributing section to request a prior discussion for large features.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarify that this repo is the web/server app, document the companion Electron repo and recommended shared root structure, and add a standard
.env.examplewith the required runtime variables.Related issue
Changes
VITE_API_URLfor hosted and local use..env.example.Example snippet:
Testing
Checklist
Fixes #<issue-number>