Rebalance README narrative to cover posts/comments alongside voting#16
Merged
Conversation
… readers Agent-Logs-Url: https://github.com/theEndless11/decentralised/sessions/a6d3c00c-ada8-4ed5-ab6c-55b5f7baaa69 Co-authored-by: thegoodduck <163307030+thegoodduck@users.noreply.github.com>
Agent-Logs-Url: https://github.com/theEndless11/decentralised/sessions/b7b62a3a-2046-4d73-b08f-49696050475c Co-authored-by: thegoodduck <163307030+thegoodduck@users.noreply.github.com>
Agent-Logs-Url: https://github.com/theEndless11/decentralised/sessions/b7b62a3a-2046-4d73-b08f-49696050475c Co-authored-by: thegoodduck <163307030+thegoodduck@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
thegoodduck
May 25, 2026 13:31
View session
There was a problem hiding this comment.
Pull request overview
Updates the top-level README to position InterPoll as a polling and discussion platform, reflecting posts/comments/community conversation alongside voting and the underlying decentralized architecture.
Changes:
- Rewrote the introduction, value proposition, and “Why it matters” to include posts/comments as first-class activity.
- Refreshed the “Key features” and “How it works” sections (including the mermaid diagram) to reference replication of polls, posts, comments, and communities.
- Reorganized the developer-facing quick start and technical deep-dive sections for readability.
| ``` | ||
|
|
||
| After voting, users get a receipt containing a short verification code. This receipt maps to a specific block in the chain. Anyone can look up a receipt in the Chain Explorer to verify that their vote was recorded and has not been altered. The verification code is a human-readable lookup identifier — it is **not** a BIP-39 wallet seed or private key, and it is safe to share. | ||
| **Run a relay** — give your community full data sovereignty. See `gun-relay/` for the GunDB relay and `relay-server.js` for the WebSocket relay. |
Comment on lines
+108
to
+111
| ```bash | ||
| chmod +x run.sh | ||
| ./run.sh | ||
| ``` |
Comment on lines
+117
to
+123
| **Frontend** (prefix with `VITE_`, set at build time): | ||
|
|
||
| The client verifies certificate signature and username/pubkey binding locally before writing `level: 'verified'` claims to GunDB (`usernames/{username}`). Issuer endpoints must be HTTPS (localhost HTTP allowed for development), and issuer domain must match endpoint host binding. | ||
| | Variable | Default | Purpose | | ||
| |---|---|---| | ||
| | `VITE_WS_RELAY_URL` | `ws://localhost:8080` | WebSocket relay | | ||
| | `VITE_GUN_RELAY_URL` | `http://localhost:8765/gun` | GunDB relay | | ||
| | `VITE_API_BASE_URL` | `http://localhost:8080` | Backend API | |
Comment on lines
+173
to
+175
| relay-server.js Dev WebSocket relay + OAuth + vote authorization | ||
| relay-server/relay-server-enhanced.js Production PM2 relay with persisted vote registry | ||
| gun-relay/gun-relay.js GunDB relay server |
Collaborator
|
damn. |
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.
The README over-indexed on voting and underrepresented InterPoll’s discussion model. This update re-centers the top-level narrative around the full product surface: polls, posts, comments, and community conversation.
Problem framing + product positioning
User-facing value props
Feature model and architecture language
Docs correctness retained while editing
SERVER_ORIGINdescription for OAuth callback URI usage in the env var table.