Compare commits

..

1 Commits

8 changed files with 310 additions and 1444 deletions

1
.gitignore vendored
View File

@@ -1 +0,0 @@
node_modules/

View File

@@ -1,55 +1,14 @@
# P2P Poll App # P2P Poll App
A peer-to-peer polling app built with [Automerge](https://automerge.org/) and Vanilla JS. No backend required — polls sync in real time across browsers using CRDTs and a WebSocket relay. P2P Poll - Minimal GUN-based Scaffolding
## Features What this is
- A tiny peer-to-peer polling app implemented with vanilla JS and GUN (a decentralized, CRDT-friendly database).
- No central server for poll data. Peers connect and synchronize the poll in real-time.
- **Add options** — type an option and press Enter or click "Add Option". Duplicate options (case-insensitive) are rejected with an inline error message. Notes
- **Vote on options** — click the vote button next to any option. You can vote on multiple options, but only once per option. - This scaffold uses GUNs browser-based peer-to-peer data replication.
- **Toggle votes** — click your vote again to remove it (the button turns green with a checkmark when you've voted). - You can extend with:
- **Live vote counts** — options are sorted by vote count in descending order and update in real time as votes come in from other users. - Persistent storage on each peer
- **2-minute countdown timer** — click "Start 2-min Vote" to begin a shared countdown. Voting is open before and during the countdown. Once the timer expires, all vote buttons are disabled. - Better conflict resolution UI
- **Shared timer** — the deadline is stored in the Automerge document, so all peers see the same countdown and voting closes simultaneously for everyone. - Optional signaling server for explicit peer discovery
- **Copy URL** — click "Copy URL" to copy the poll link to your clipboard. Share it with others to join the same poll.
- **P2P sync** — all state (options, votes, timer) syncs across browsers in real time with no central server handling your data.
## How it works
### Tech stack
- **[Automerge](https://automerge.org/)** via `@automerge/vanillajs` — a CRDT library that lets multiple clients concurrently edit shared documents and merge changes without conflicts.
- **BroadcastChannelNetworkAdapter** — syncs between tabs in the same browser instantly via the browser's BroadcastChannel API.
- **WebSocketClientAdapter** — syncs across different browsers/devices via a WebSocket relay (`wss://sync.automerge.org`). The relay only forwards CRDT messages; it does not store or interpret your data.
- **IndexedDBStorageAdapter** — persists the document locally so it survives page refreshes.
- **Vite** — bundles the app with WebAssembly support (required by Automerge).
### Data model
The poll is a single Automerge document with three fields:
```js
{
options: string[], // list of poll options in insertion order
votes: { [option]: number }, // vote count per option
deadline: number | null // Unix timestamp (ms) when voting closes, or null
}
```
### URL-based sharing
Each document gets a unique Automerge URL (e.g. `automerge:abc123...`) stored in the page's URL hash. Opening the same URL in any browser loads and syncs the same document. Creating a new poll generates a new document and updates the hash automatically.
### Voting rules
- Voted options are tracked in `localStorage` (keyed by document URL), so they persist across page refreshes but are isolated per browser.
- One vote per option per user. Votes can be toggled off and back on until the timer expires.
- The timer (`doc.deadline`) is set once by whoever clicks "Start 2-min Vote" and is shared via the Automerge document, so all peers use the same deadline.
## Running locally
```bash
pnpm install
pnpm dev
```
Open the printed localhost URL. To test cross-browser sync, copy the URL (including the `#automerge:...` hash) and open it in a different browser.

368
app.js
View File

@@ -1,214 +1,200 @@
import { // Minimal GUN-based P2P Poll scaffold (vanilla JS)
Repo,
BroadcastChannelNetworkAdapter,
WebSocketClientAdapter,
IndexedDBStorageAdapter,
isValidAutomergeUrl,
} from "@automerge/vanillajs";
const REPO = new Repo({ (function() {
network: [ // Initialize GUN (no server needed; can optionally connect to a relay server)
new BroadcastChannelNetworkAdapter(), // If you want a local-only node for prototyping: Gun()
new WebSocketClientAdapter("wss://sync.automerge.org"), // If you want to use a signaling server for discovery, pass a list of peers to Gun().opt({peers: [...]})
], const gun = Gun();
storage: new IndexedDBStorageAdapter(),
});
let HANDLE; // DOM helpers
const pollSection = document.getElementById('poll');
const pollIdInput = document.getElementById('pollId');
const loadPollBtn = document.getElementById('loadPollBtn');
const createPollBtn = document.getElementById('createPollBtn');
const pollTitleInput = document.getElementById('pollTitle');
const setTitleBtn = document.getElementById('setTitleBtn');
const optionsDiv = document.getElementById('options');
const newOptionInput = document.getElementById('newOption');
const addOptionBtn = document.getElementById('addOptionBtn');
const totalVotesSpan = document.getElementById('totalVotes');
const pollIdDisplay = document.getElementById('pollIdDisplay');
function getVotedKey(docUrl) { let currentPollId = null;
return `p2p-poll-voted:${docUrl}`; let pollsRef = null; // Gun node for /polls/{pollId}
} let pollData = null; // local cache
function getVotedOptions() { // Helpers
const key = getVotedKey(document.location.hash); function renderOptionList(options) {
return new Set(JSON.parse(localStorage.getItem(key) || "[]")); optionsDiv.innerHTML = '';
} const keys = Object.keys(options || {});
if (keys.length === 0) {
function markVoted(opt) { optionsDiv.innerHTML = '<p>No options yet. Add one below.</p>';
const key = getVotedKey(document.location.hash); return;
const voted = getVotedOptions(); }
voted.add(opt); keys.forEach((optId) => {
localStorage.setItem(key, JSON.stringify([...voted])); const opt = options[optId];
} const el = document.createElement('div');
el.className = 'option';
function unmarkVoted(opt) { el.innerHTML = `
const key = getVotedKey(document.location.hash); <span class="text">${opt.text}</span>
const voted = getVotedOptions(); <button data-optid="${optId}" class="voteBtn">Vote (${opt.votes || 0})</button>
voted.delete(opt); `;
localStorage.setItem(key, JSON.stringify([...voted])); optionsDiv.appendChild(el);
} });
const locationHash = document.location.hash.substring(1);
const statusEl = document.getElementById("status");
const optionsList = document.getElementById("options-list");
const optionInput = document.getElementById("option-input");
const addBtn = document.getElementById("add-btn");
const duplicateMsg = document.getElementById("duplicate-msg");
const copyBtn = document.getElementById("copy-btn");
const timerEl = document.getElementById("timer");
const startVotingBtn = document.getElementById("start-voting-btn");
if (isValidAutomergeUrl(locationHash)) {
statusEl.textContent = "Loading document…";
try {
HANDLE = await REPO.find(locationHash);
statusEl.textContent = "";
} catch (err) {
statusEl.textContent = "Could not load document. Starting a new one.";
HANDLE = REPO.create({ options: [], votes: {}, deadline: null });
document.location.hash = HANDLE.url;
} }
} else {
HANDLE = REPO.create({ options: [], votes: {}, deadline: null });
document.location.hash = HANDLE.url;
}
HANDLE.on("change", ({ doc }) => render(doc)); function updateTotalVotes() {
const opts = pollData && pollData.options ? pollData.options : {};
const total = Object.values(opts).reduce((sum, o) => sum + (o.votes || 0), 0);
totalVotesSpan.textContent = total;
}
const initialDoc = HANDLE.doc(); // Load existing poll and subscribe to changes
if (initialDoc) render(initialDoc); function loadPoll(pollId) {
if (!pollId) return;
let timerInterval = null; currentPollId = pollId;
pollIdDisplay.textContent = pollId;
pollsRef = gun.get('polls').get(pollId);
function render(doc) { // Initialize structure if new poll
renderOptions(doc); pollsRef.get('title').put('Untitled Poll');
renderTimer(doc); pollsRef.get('options').put({}); // ensure map exists
}
function renderOptions(doc) { // Real-time updates: listen to changes
const votes = doc.votes || {}; pollsRef.get('title').on((title) => {
const deadline = doc.deadline ?? null; pollTitleInput.value = title || '';
const now = Date.now();
const votingClosed = deadline !== null && now >= deadline;
const votedOptions = getVotedOptions();
const sorted = [...(doc.options || [])].sort(
(a, b) => (votes[b] || 0) - (votes[a] || 0),
);
optionsList.innerHTML = "";
sorted.forEach((opt) => {
const count = votes[opt] || 0;
const alreadyVoted = votedOptions.has(opt);
const item = document.createElement("div");
item.className = "option-item";
const label = document.createElement("span");
label.className = "option-label";
label.textContent = opt;
const voteBtn = document.createElement("button");
voteBtn.className = alreadyVoted ? "vote-btn voted" : "vote-btn";
voteBtn.textContent = alreadyVoted ? `${count}` : `${count}`;
voteBtn.disabled = votingClosed;
if (votingClosed) voteBtn.title = "Voting is closed";
else if (alreadyVoted) voteBtn.title = "Click to remove your vote";
voteBtn.addEventListener("click", () => {
if (alreadyVoted) {
unmarkVoted(opt);
HANDLE.change((d) => {
if (!d.votes) d.votes = {};
d.votes[opt] = Math.max(0, (d.votes[opt] || 0) - 1);
});
} else {
markVoted(opt);
HANDLE.change((d) => {
if (!d.votes) d.votes = {};
d.votes[opt] = (d.votes[opt] || 0) + 1;
});
}
}); });
item.appendChild(label); pollsRef.on((data) => {
item.appendChild(voteBtn); // data is the entire poll node if subscribed; but we explore explicit fields
optionsList.appendChild(item); });
});
}
function renderTimer(doc) { // For options map
const deadline = doc?.deadline ?? null; pollsRef.get('options').on((opts) => {
const now = Date.now(); // opts is the entire options map; convert to plain object
const optionsObj = toPlainObject(opts);
pollData = {
title: null,
options: optionsObj
};
renderOptionList(optionsObj);
updateTotalVotes();
});
if (deadline === null) { // Also listen for title changes separately (in case some clients push via title path)
timerEl.textContent = ""; pollsRef.get('title').on((title) => {
startVotingBtn.hidden = false; pollTitleInput.value = title || '';
return; });
// Show UI
document.getElementById('setup').style.display = 'none';
pollSection.style.display = 'block';
} }
startVotingBtn.hidden = true; // Create a new poll
function createPoll() {
if (now >= deadline) { const pollId = pollIdInput.value.trim();
timerEl.textContent = "Voting closed."; if (!pollId) {
timerEl.className = "timer closed"; alert('Please enter a poll ID to create.');
clearInterval(timerInterval); return;
timerInterval = null; }
return; currentPollId = pollId;
// Initialize poll
pollsRef = gun.get('polls').get(pollId);
pollsRef.put({
title: 'New Poll',
});
pollsRef.get('options').put({}); // ensure map exists
// reflect in UI
pollIdDisplay.textContent = pollId;
pollTitleInput.value = 'New Poll';
pollSection.style.display = 'block';
document.getElementById('setup').style.display = 'none';
} }
const remaining = Math.ceil((deadline - now) / 1000); // Add option
const mins = Math.floor(remaining / 60); function addOption() {
const secs = remaining % 60; if (!pollsRef) {
timerEl.textContent = `Voting closes in ${mins}:${secs.toString().padStart(2, "0")}`; alert('Load or create a poll first.');
timerEl.className = "timer active"; return;
}
if (!timerInterval) { const text = newOptionInput.value.trim();
timerInterval = setInterval(() => { if (!text) return;
const d = HANDLE.doc(); const optionId = 'opt_' + Date.now();
if (!d) return; pollsRef.get('options').get(optionId).put({ text, votes: 0 });
renderTimer(d); newOptionInput.value = '';
renderOptions(d);
if (Date.now() >= d.deadline) {
clearInterval(timerInterval);
timerInterval = null;
}
}, 1000);
}
}
startVotingBtn.addEventListener("click", () => {
HANDLE.change((d) => {
d.deadline = Date.now() + 2 * 60 * 1000;
});
});
addBtn.addEventListener("click", () => {
const value = optionInput.value.trim();
if (!value) return;
const doc = HANDLE.doc();
const valueLower = value.toLowerCase();
const isDuplicate = (doc?.options || []).some(
(opt) => opt.toLowerCase() === valueLower,
);
if (isDuplicate) {
duplicateMsg.textContent = `"${value}" is already in the list.`;
duplicateMsg.hidden = false;
return;
} }
duplicateMsg.hidden = true; // Set title
HANDLE.change((d) => { function setTitle() {
if (!d.options) d.options = []; if (!pollsRef) return;
d.options.push(value); const title = pollTitleInput.value.trim() || 'Untitled';
pollsRef.get('title').put(title);
}
// Vote handler (delegated)
function handleVoteClick(e) {
if (e.target.classList.contains('voteBtn')) {
const optId = e.target.getAttribute('data-optid');
if (!optId || !pollsRef) return;
const optRef = pollsRef.get('options').get(optId);
// Increment votes locally
optRef.get('votes').once((v) => {
const current = v || 0;
optRef.put({ votes: current + 1 });
});
// UI will update via the on() listener on options map
}
}
// Utilities
function toPlainObject(obj) {
// Gun emits special proxy-like objects; convert to plain object
if (!obj) return {};
// If it's already a plain object, return
if (typeof obj !== 'object') return {};
// Gun events deliver object-like; attempt shallow copy
try {
const copy = JSON.parse(JSON.stringify(obj));
return copy;
} catch (e) {
// Fallback: return as-is if cannot stringify
return obj;
}
}
// Event bindings
loadPollBtn.addEventListener('click', () => {
const id = pollIdInput.value.trim();
if (!id) {
alert('Enter a Poll ID to load.');
return;
}
loadPoll(id);
}); });
optionInput.value = "";
});
optionInput.addEventListener("keydown", (e) => { createPollBtn.addEventListener('click', () => {
if (e.key === "Enter") addBtn.click(); createPoll();
});
optionInput.addEventListener("input", () => {
duplicateMsg.hidden = true;
});
copyBtn.addEventListener("click", () => {
navigator.clipboard.writeText(window.location.href).then(() => {
copyBtn.textContent = "Copied!";
setTimeout(() => (copyBtn.textContent = "Copy URL"), 1500);
}); });
});
addOptionBtn.addEventListener('click', addOption);
newOptionInput.addEventListener('keydown', (ev) => {
if (ev.key === 'Enter') addOption();
});
setTitleBtn.addEventListener('click', setTitle);
// Delegate vote clicks
optionsDiv.addEventListener('click', handleVoteClick);
// Initialize: optionally auto-create a poll if URL param present
// Example: ?pollId=my-poll-123
const urlParams = new URLSearchParams(window.location.search);
const autoPoll = urlParams.get('pollId');
if (autoPoll) {
pollIdInput.value = autoPoll;
loadPoll(autoPoll);
}
})();

View File

@@ -1,31 +1,55 @@
<!doctype html> <!doctype html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8" /> <meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>P2P Polling App</title> <title>P2P Poll</title>
<link rel="stylesheet" href="./styles.css" /> <link rel="stylesheet" href="styles.css" />
</head> <!-- Gun.js via CDN for quick start -->
<body> <script src="https://unpkg.com/gun/gun.js"></script>
<div id="app"> </head>
<h1>P2P Polling App</h1> <body>
<div id="status"></div> <div class="container">
<div id="add-option"> <h1>P2P Poll</h1>
<input
type="text" <section id="setup" class="card">
id="option-input" <h2>Start or Join Poll</h2>
placeholder="Enter an option..." <div class="field">
/> <label for="pollId">Poll ID (share with peer):</label>
<button id="add-btn">Add Option</button> <input id="pollId" type="text" placeholder="e.g. my-poll-123" />
</div> </div>
<div id="duplicate-msg" hidden></div> <button id="loadPollBtn">Load Poll</button>
<div id="timer-section"> <button id="createPollBtn">Create New Poll</button>
<div id="timer"></div> <p class="note">Tip: You can run two instances and connect by using the same Poll ID.</p>
<button id="start-voting-btn">Start 2-min Vote</button> </section>
</div>
<div id="options-list"></div> <section id="poll" class="card" style="display:none;">
<button id="copy-btn">Copy URL</button> <h2>Poll</h2>
</div> <div class="field">
<script type="module" src="./app.js"></script> <label for="pollTitle">Poll Title</label>
</body> <input id="pollTitle" type="text" placeholder="Poll Title" />
<button id="setTitleBtn">Set Title</button>
</div>
<div id="options" class="options">
<!-- dynamic options will render here -->
</div>
<div class="field">
<input id="newOption" type="text" placeholder="Add a new option" />
<button id="addOptionBtn">Add Option</button>
</div>
<div class="summary">
<p>Total votes: <span id="totalVotes">0</span></p>
</div>
<div class="share">
<p>Share Poll ID with peer: <code id="pollIdDisplay"></code></p>
</div>
</section>
</div>
<script src="app.js"></script>
</body>
</html> </html>

View File

@@ -1,23 +0,0 @@
{
"name": "p2p-poll-app",
"type": "module",
"engines": {
"node": ">=24"
},
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview"
},
"dependencies": {
"@automerge/automerge-repo": "^2.0.0",
"@automerge/automerge-repo-network-websocket": "^2.0.0",
"@automerge/automerge-repo-storage-indexeddb": "^2.0.0",
"@automerge/vanillajs": "^2.5.3"
},
"devDependencies": {
"vite": "^6.0.0",
"vite-plugin-top-level-await": "^1.4.0",
"vite-plugin-wasm": "^3.3.0"
}
}

1083
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,93 +1,104 @@
:root {
--bg: #0f1220;
--card: #1a1740;
--text: #e8e3ff;
--muted: #b8a7d2;
--accent: #6bd3ff;
}
* {
box-sizing: border-box;
}
html,
body { body {
margin: 0;
padding: 0;
font-family: sans-serif; font-family: sans-serif;
max-width: 480px; background: #0b0a14;
color: #fff;
height: 100%;
}
.container {
max-width: 700px;
margin: 40px auto; margin: 40px auto;
padding: 0 16px; padding: 0 16px;
} }
#add-option { .card {
background: #1f1740;
border-radius: 12px;
padding: 16px;
margin-bottom: 14px;
border: 1px solid #2a1950;
}
.field {
margin-bottom: 12px;
display: flex; display: flex;
gap: 8px; gap: 8px;
margin-bottom: 8px; align-items: center;
} }
#option-input { label {
min-width: 180px;
}
input[type="text"] {
flex: 1; flex: 1;
padding: 8px; padding: 8px;
font-size: 1rem; border-radius: 6px;
border: 1px solid #ccc; border: 1px solid #5a2d8a;
border-radius: 4px; background: #2a174f;
} color: #fff;
#duplicate-msg {
color: #c00;
font-size: 0.9rem;
margin-bottom: 12px;
} }
button { button {
padding: 8px 16px; padding: 8px 12px;
font-size: 1rem; border-radius: 6px;
border: none;
background: #6bd3ff;
color: #04152a;
font-weight: bold;
cursor: pointer; cursor: pointer;
border: 1px solid #ccc;
border-radius: 4px;
background: #fff;
} }
button:hover:not(:disabled) { button:hover {
background: #f0f0f0; opacity: 0.95;
} }
button:disabled { .options {
opacity: 0.5;
cursor: default;
}
#timer-section {
display: flex; display: flex;
align-items: center; flex-direction: column;
gap: 12px; gap: 8px;
margin-bottom: 16px; margin-top: 6px;
} }
.timer.active { .option {
font-weight: bold;
color: #1a6e1a;
}
.timer.closed {
font-weight: bold;
color: #c00;
}
.option-item {
display: flex; display: flex;
align-items: center;
justify-content: space-between; justify-content: space-between;
padding: 10px 12px; align-items: center;
border: 1px solid #ddd; padding: 8px;
border-radius: 4px; background: #2a174f;
margin-bottom: 8px; border: 1px solid #40217a;
border-radius: 6px;
} }
.option-label { .option .text {
flex: 1; flex: 1;
} }
.vote-btn { .share {
padding: 4px 12px; font-size: 0.9em;
font-size: 0.9rem; color: var(--muted);
white-space: nowrap;
} }
.vote-btn.voted { .note {
background: #e6f4e6; color: #c8b5ff;
border-color: #4a9e4a; font-size: 0.9em;
color: #2a6e2a;
} }
.total {
#copy-btn { font-weight: bold;
margin-top: 16px;
width: 100%;
} }

View File

@@ -1,7 +0,0 @@
import { defineConfig } from 'vite'
import wasm from 'vite-plugin-wasm'
import topLevelAwait from 'vite-plugin-top-level-await'
export default defineConfig({
plugins: [wasm(), topLevelAwait()]
})