commit 1512c2a895ffe107d47c71f3a6d40859744c70b3 Author: ServerBob Date: Thu Mar 5 05:03:57 2026 +0000 chore: initial custom pulse noise stack snapshot diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..c6cc46b --- /dev/null +++ b/.dockerignore @@ -0,0 +1,4 @@ +data/ +node_modules/ +.env +.git/ diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..d93409c --- /dev/null +++ b/.env.example @@ -0,0 +1,51 @@ +# ============================================================================= +# Pulse — Environment Variables +# ============================================================================= +# Copy this file to .env and fill in the values for your environment. + +# ----------------------------------------------------------------------------- +# Database +# ----------------------------------------------------------------------------- +DATABASE_URL=postgresql://postgres:your-password@localhost:5432/postgres + +# ----------------------------------------------------------------------------- +# Supabase +# ----------------------------------------------------------------------------- +SUPABASE_URL=http://localhost:8000 +SUPABASE_ANON_KEY=your-supabase-anon-key +SUPABASE_SERVICE_ROLE_KEY=your-supabase-service-role-key + +# ----------------------------------------------------------------------------- +# Client (Vite build-time — must be prefixed with VITE_) +# ----------------------------------------------------------------------------- +VITE_SUPABASE_URL=http://localhost:8000 +VITE_SUPABASE_ANON_KEY=your-supabase-anon-key + +# ----------------------------------------------------------------------------- +# OAuth Providers (optional, set to "true" to enable) +# ----------------------------------------------------------------------------- +GOOGLE_OAUTH_ENABLED=false +DISCORD_OAUTH_ENABLED=false +FACEBOOK_OAUTH_ENABLED=false +TWITCH_OAUTH_ENABLED=false + +# ----------------------------------------------------------------------------- +# WebRTC / Voice +# ----------------------------------------------------------------------------- +# Public IP for WebRTC ICE candidates (required for Docker / remote access) +# PUBLIC_IP=203.0.113.1 + +# ----------------------------------------------------------------------------- +# Registration +# ----------------------------------------------------------------------------- +# Set to "true" to disable all new user registration instance-wide. +# Existing users can still log in. Invites bypass this restriction. +# REGISTRATION_DISABLED=false + +# ----------------------------------------------------------------------------- +# Optional +# ----------------------------------------------------------------------------- +# GIPHY_API_KEY=your-giphy-api-key +# TRUST_PROXY=true +# RUNNING_IN_DOCKER=true +# DEBUG=true diff --git a/.env.supabase.example b/.env.supabase.example new file mode 100644 index 0000000..afee55d --- /dev/null +++ b/.env.supabase.example @@ -0,0 +1,57 @@ +# ============================================================================= +# Pulse — Self-Hosted Supabase Environment Variables +# ============================================================================= +# Copy this file to .env and fill in the values. +# Use with: docker compose -f docker-compose-supabase.yml up -d + +# === REQUIRED === + +# PostgreSQL password for the local database (must be URL-safe: no / = + characters) +# Generate with: openssl rand -hex 24 +POSTGRES_PASSWORD= + +# JWT secret used by GoTrue and PostgreSQL (min 32 chars) +# Generate with: openssl rand -base64 32 +JWT_SECRET= + +# Supabase API keys (JWTs signed with JWT_SECRET above) +# Generate both keys by running: bun docker/generate-keys.ts +SUPABASE_ANON_KEY= +SUPABASE_SERVICE_ROLE_KEY= + +# Public URL where Pulse is accessible (used by GoTrue for redirects) +SITE_URL= + +# === OPTIONAL === + +# JWT expiry in seconds (default: 3600 = 1 hour) +# JWT_EXPIRY=3600 + +# Host port for Pulse (default: 4991) +# PULSE_PORT=4991 + +# Server's public IP for WebRTC (auto-detected if not set) +# PUBLIC_IP= + +# Additional OAuth redirect URLs (comma-separated) +# ADDITIONAL_REDIRECT_URLS= + +# OAuth providers (set to "true" to enable, then fill in client ID and secret) +# GOOGLE_OAUTH_ENABLED=false +# GOOGLE_OAUTH_CLIENT_ID= +# GOOGLE_OAUTH_SECRET= +# DISCORD_OAUTH_ENABLED=false +# DISCORD_OAUTH_CLIENT_ID= +# DISCORD_OAUTH_SECRET= +# FACEBOOK_OAUTH_ENABLED=false +# FACEBOOK_OAUTH_CLIENT_ID= +# FACEBOOK_OAUTH_SECRET= +# TWITCH_OAUTH_ENABLED=false +# TWITCH_OAUTH_CLIENT_ID= +# TWITCH_OAUTH_SECRET= + +# Disable all new user registration instance-wide (invites still work) +# REGISTRATION_DISABLED=false + +# Giphy API key for GIF search +# GIPHY_API_KEY= diff --git a/.github/codeql/codeql-config.yml b/.github/codeql/codeql-config.yml new file mode 100644 index 0000000..48e22bb --- /dev/null +++ b/.github/codeql/codeql-config.yml @@ -0,0 +1,28 @@ +queries: + - uses: security-and-quality + - uses: ./.github/codeql/custom-queries + +paths-ignore: + # Build scripts, migration scripts, and test helpers — not runtime code + - apps/server/build/** + - apps/server/src/scripts/** + - apps/desktop/scripts/** + - '**/__tests__/**' + +query-filters: + # Exclude the built-in js/request-forgery query so our custom version + # (with the validateFederationUrl sanitizer) takes its place. + - exclude: + id: js/request-forgery + # URL routing is not a "bypass" — rate limiting and auth are applied per-route + - exclude: + id: js/user-controlled-bypass + # CORS origin is validated via isAllowedOrigin() against a server-side allowlist + - exclude: + id: js/cors-misconfiguration-for-credentials + # localStorage is used for client-side preferences and session persistence by design + - exclude: + id: js/clear-text-storage-of-sensitive-data + # GitHub Actions workflows already have explicit top-level permissions blocks + - exclude: + id: actions/missing-workflow-permissions diff --git a/.github/codeql/custom-queries/RequestForgery.ql b/.github/codeql/custom-queries/RequestForgery.ql new file mode 100644 index 0000000..33d989c --- /dev/null +++ b/.github/codeql/custom-queries/RequestForgery.ql @@ -0,0 +1,48 @@ +/** + * @name Server-side request forgery + * @description Making a network request with user-controlled data in the URL + * allows for request forgery attacks. + * @kind path-problem + * @problem.severity error + * @security-severity 9.1 + * @precision high + * @id js/request-forgery + * @tags security + * external/cwe/cwe-918 + */ + +import javascript +import semmle.javascript.security.dataflow.RequestForgeryQuery +import RequestForgeryFlow::PathGraph + +/** + * Treat calls to validateFederationUrl() as a request-forgery sanitizer. + * + * validateFederationUrl (apps/server/src/utils/validate-url.ts) validates that + * a URL does not target private or internal network resources by: + * - Rejecting non-HTTP(S) schemes + * - Checking the hostname against private IP ranges (RFC 1918, loopback, link-local) + * - Resolving DNS and checking resolved IPs against the same private ranges + * + * The function throws if the URL is unsafe, so if execution continues past the + * call, the returned URL object is safe to fetch. Marking the call node as a + * barrier prevents taint from flowing through the return value. + */ +private class ValidateFederationUrlSanitizer extends RequestForgery::Sanitizer { + ValidateFederationUrlSanitizer() { + exists(DataFlow::CallNode call | + call.getCalleeName() = "validateFederationUrl" and + this = call + ) + } +} + +from + RequestForgeryFlow::PathNode source, RequestForgeryFlow::PathNode sink, + DataFlow::Node request +where + RequestForgeryFlow::flowPath(source, sink) and + request = sink.getNode().(RequestForgery::Sink).getARequest() +select request, source, sink, "The $@ of this request depends on a $@.", + sink.getNode(), sink.getNode().(RequestForgery::Sink).getKind(), source, + "user-provided value" diff --git a/.github/codeql/custom-queries/qlpack.yml b/.github/codeql/custom-queries/qlpack.yml new file mode 100644 index 0000000..59991b0 --- /dev/null +++ b/.github/codeql/custom-queries/qlpack.yml @@ -0,0 +1,4 @@ +name: pulse/codeql-custom-queries +version: 0.0.1 +dependencies: + codeql/javascript-all: "*" diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..3897c82 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,33 @@ +name: CodeQL + +on: + push: + branches: [main, dev] + pull_request: + branches: [main, dev] + schedule: + - cron: '0 6 * * 1' # Every Monday at 06:00 UTC + +permissions: + security-events: write + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: javascript-typescript + config-file: ./.github/codeql/codeql-config.yml + + - name: Autobuild + uses: github/codeql-action/autobuild@v3 + + - name: Run CodeQL analysis + uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/desktop-release.yml b/.github/workflows/desktop-release.yml new file mode 100644 index 0000000..f2205fb --- /dev/null +++ b/.github/workflows/desktop-release.yml @@ -0,0 +1,160 @@ +name: Desktop Release + +on: + workflow_dispatch: + inputs: + version: + description: "Release version (e.g. 0.1.0). Leave empty to use package.json version." + required: false + type: string + +permissions: + contents: write + +jobs: + build-desktop: + strategy: + fail-fast: false + matrix: + include: + - os: macos-latest + platform: darwin + arch: arm64 + make_targets: --platform=darwin --arch=arm64 + - os: ubuntu-latest + platform: linux + arch: x64 + make_targets: --platform=linux --arch=x64 + - os: windows-latest + platform: win32 + arch: x64 + make_targets: --platform=win32 --arch=x64 + + runs-on: ${{ matrix.os }} + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install Bun + uses: oven-sh/setup-bun@v2 + with: + bun-version: latest + + # Linux: install RPM tooling for MakerRpm + - name: Install Linux packaging deps + if: matrix.platform == 'linux' + run: sudo apt-get update && sudo apt-get install -y rpm + + # macOS: install CMake for native audio modules + - name: Install CMake (macOS) + if: matrix.platform == 'darwin' + run: brew install cmake + + # macOS: import code signing certificate (optional) + - name: Import code signing certificate + if: matrix.platform == 'darwin' && env.APPLE_CERTIFICATE_BASE64 != '' + env: + APPLE_CERTIFICATE_BASE64: ${{ secrets.APPLE_CERTIFICATE_BASE64 }} + APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }} + run: | + CERT_FILE=$(mktemp /tmp/cert.XXXXXX.p12) + echo "$APPLE_CERTIFICATE_BASE64" | base64 --decode > "$CERT_FILE" + KEYCHAIN=build.keychain + security create-keychain -p "" "$KEYCHAIN" + security default-keychain -s "$KEYCHAIN" + security unlock-keychain -p "" "$KEYCHAIN" + security import "$CERT_FILE" -k "$KEYCHAIN" -P "$APPLE_CERTIFICATE_PASSWORD" -T /usr/bin/codesign + security set-key-partition-list -S apple-tool:,apple: -s -k "" "$KEYCHAIN" + rm "$CERT_FILE" + + - name: Install dependencies + run: bun install + + # macOS: build native CoreAudio modules + - name: Build native modules (macOS) + if: matrix.platform == 'darwin' + working-directory: apps/desktop + run: bun run build:native + + - name: Build desktop app + working-directory: apps/desktop + run: bun run build + + - name: Package with Electron Forge + working-directory: apps/desktop + env: + APPLE_IDENTITY: ${{ secrets.APPLE_IDENTITY }} + APPLE_ID: ${{ secrets.APPLE_ID }} + APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }} + APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }} + run: bun run forge -- make ${{ matrix.make_targets }} + + # macOS: patch Info.plist for media permissions + - name: Patch macOS bundle + if: matrix.platform == 'darwin' + working-directory: apps/desktop + run: bash scripts/patch-macos.sh + + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: desktop-${{ matrix.platform }}-${{ matrix.arch }} + path: | + apps/desktop/out/make/**/*.dmg + apps/desktop/out/make/**/*.zip + apps/desktop/out/make/**/*.deb + apps/desktop/out/make/**/*.rpm + if-no-files-found: error + + release: + needs: build-desktop + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Determine version + id: version + run: | + if [ -n "${{ inputs.version }}" ]; then + echo "tag=v${{ inputs.version }}" >> "$GITHUB_OUTPUT" + echo "name=Desktop v${{ inputs.version }}" >> "$GITHUB_OUTPUT" + else + VERSION=$(jq -r .version apps/desktop/package.json) + echo "tag=desktop-v${VERSION}" >> "$GITHUB_OUTPUT" + echo "name=Desktop v${VERSION}" >> "$GITHUB_OUTPUT" + fi + + - name: Download all artifacts + uses: actions/download-artifact@v4 + with: + path: artifacts + merge-multiple: false + + - name: List artifacts + run: find artifacts -type f | head -50 + + - name: Create GitHub Release + uses: softprops/action-gh-release@v2 + with: + tag_name: ${{ steps.version.outputs.tag }} + name: ${{ steps.version.outputs.name }} + draft: true + files: | + artifacts/**/*.dmg + artifacts/**/*.zip + artifacts/**/*.deb + artifacts/**/*.rpm + body: | + ## Desktop Client + + ### Downloads + | Platform | File | + |----------|------| + | macOS (Apple Silicon) | `.dmg` or `.zip` | + | Windows | `.zip` | + | Linux (Debian/Ubuntu) | `.deb` | + | Linux (Fedora/RHEL) | `.rpm` | + + ### Notes + (TODO) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..cfe5852 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,106 @@ +name: Manual Release + +on: + workflow_dispatch: + inputs: + bump: + description: "Version bump" + required: true + type: choice + options: + - none + - patch + - minor + - major + default: "none" + +permissions: + contents: write + packages: write + +jobs: + build-and-publish: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install Bun + uses: oven-sh/setup-bun@v1 + with: + bun-version: 1.3.5 + + - name: Install dependencies + run: bun install + + - name: Build app + run: | + cd apps/server + bun run build --bump ${{ inputs.bump }} + + - name: Get new version + id: get_version + run: echo "version=$(jq -r .version package.json)" >> "$GITHUB_OUTPUT" + + - name: Identify user + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Log in to GHCR + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Build and push Docker image + uses: docker/build-push-action@v5 + with: + context: . + platforms: linux/amd64 + push: true + tags: | + ghcr.io/${{ github.repository }}:latest + ghcr.io/${{ github.repository }}:v${{ steps.get_version.outputs.version }} + labels: | + org.opencontainers.image.title=Pulse + org.opencontainers.image.description=Pulse Server + org.opencontainers.image.version=${{ steps.get_version.outputs.version }} + org.opencontainers.image.source=${{ github.server_url }}/${{ github.repository }} + + - name: Create GitHub release + uses: softprops/action-gh-release@v2 + with: + tag_name: v${{ steps.get_version.outputs.version }} + name: v${{ steps.get_version.outputs.version }} + draft: true + files: | + apps/server/build/out/pulse-linux-x64 + apps/server/build/out/pulse-linux-arm64 + apps/server/build/out/pulse-windows-x64.exe + apps/server/build/out/pulse-macos-x64 + apps/server/build/out/pulse-macos-arm64 + apps/server/build/out/release.json + body: | + ## Changes + (TODO) + + ## Docker Image + ```bash + docker pull ghcr.io/${{ github.repository }}:v${{ steps.get_version.outputs.version }} + ``` + - name: Commit and push version bump + if: ${{ inputs.bump != 'none' }} + run: | + git add . + git commit -m "chore: bump version to ${{ steps.get_version.outputs.version }}" + git push + + - name: Create Git tag + run: | + git tag -a "v${{ steps.get_version.outputs.version }}" -m "Release v${{ steps.get_version.outputs.version }}" + git push origin "v${{ steps.get_version.outputs.version }}" diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..76c61c1 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,81 @@ +name: Tests + +on: + push: + pull_request: + +permissions: + contents: read + +jobs: + lint: + name: Lint & Type Check + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Bun + uses: oven-sh/setup-bun@v1 + with: + bun-version: latest + + - name: Install dependencies + run: bun install + + - name: Check types + run: bun run check-types + + - name: Lint + run: bun run lint + + test: + name: Run Tests + runs-on: ubuntu-latest + + services: + postgres: + image: postgres:16 + env: + POSTGRES_USER: pulse_test + POSTGRES_PASSWORD: pulse_test + POSTGRES_DB: pulse_test + ports: + - 5432:5432 + options: >- + --health-cmd "pg_isready -U pulse_test" + --health-interval 10s + --health-timeout 5s + --health-retries 5 + + env: + DATABASE_URL: postgresql://pulse_test:pulse_test@localhost:5432/pulse_test + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Bun + uses: oven-sh/setup-bun@v1 + with: + bun-version: latest + + - name: Install dependencies + run: bun install + + - name: Wait for PostgreSQL + run: | + for i in $(seq 1 30); do + pg_isready -h localhost -p 5432 -U pulse_test && break + echo "Waiting for postgres ($i/30)..." + sleep 2 + done + + - name: Generate Drizzle migrations + working-directory: apps/server + run: bun run db:gen + + - name: Run server tests + working-directory: apps/server + run: bun test diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6dc1670 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +/node_modules +/.github/copilot-instructions.md +/cenas.txt +/cenas.md +/DockerCenas +/experiments +.env +bun.lock +apps/desktop/dist/ +apps/desktop/out/ +apps/desktop/node_modules +apps/server/node_modules +apps/client/node_modules +.DS_Store +*.tsbuildinfo +Thumbs.db +docker-compose.yml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7b2feb1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,155 @@ +# Contributing to Pulse + +Thanks for contributing. This document explains how we work so your changes can land smoothly and nobody wastes time on work we can't merge. + +## Quick rules (please read) + +### 1) All PRs must target `dev` + +`dev` is our trunk branch. Open all pull requests against `dev`. PRs targeting other branches will be closed or retargeted. Periodically, `dev` is merged into `main` for stable releases. + +### 2) All PRs must include a short description + +Every PR must include a short description covering: + +- what changed +- why it changed +- anything reviewers should pay attention to + +A few bullets is fine. + +### 3) Open an issue before submitting a PR + +We strongly prefer that every PR addresses an existing issue. If one doesn't exist yet, open one describing the problem or improvement and your proposed approach. This gives maintainers a chance to weigh in on direction before you invest time, and avoids the mutual displeasure of: + +- you doing significant work, and +- us having to reject or postpone the change because it doesn't align with current goals, or because we aren't ready to maintain what it introduces + +For small, obvious fixes (typos, broken links, trivial one-liners) you can skip the issue and go straight to a PR. + +Ways to coordinate on larger work: + +- open an issue describing the problem and your proposed approach +- open a draft PR early to confirm direction +- discuss with a maintainer in any channel you already share + +If you're unsure whether something needs an issue first, it probably does. + +### 4) Understand the code you submit + +You must have sufficient understanding of every change in your PR to explain it and defend it during review. You don't need to write an essay, but you should be able to give a short summary of what the patch does and why it's correct. + +**LLM-assisted contributions.** You're welcome to use LLMs as a tool for automating mechanical work. We don't ask you to disclose this, since we assume you're acting in good faith: you're the one who signs off on the patch you submit in your own name, and you have the technical understanding to verify that it's accurate. + +That said, don't use LLMs on areas of the codebase you don't understand well enough to verify the output. If part of your change touches code you aren't confident reviewing yourself, say so in the issue you opened beforehand and defer that work to someone else. The maintainers will be happy to help. + +## Project structure + +Pulse is a monorepo managed with Bun workspaces: + +- `apps/server/` — backend (Bun, tRPC, Drizzle ORM, PostgreSQL) +- `apps/client/` — frontend (React, Vite) +- `packages/shared/` — shared types and constants + +## Workflow + +1. Fork the repo (or create a branch if you have access). +2. Create a feature branch from `dev`. +3. Make changes. +4. Open a PR into `dev` with a short description. +5. Address review feedback and CI results. +6. We squash-merge approved PRs into `dev`. + +We strongly prefer small, focused PRs that are easy to review. + +### Commit style and history + +We squash-merge PRs, so the PR title becomes the single commit message on `dev`. For that reason: + +- PR titles must follow Conventional Commits. +- Individual commits inside the PR don't need to follow Conventional Commits. + +If you like to commit in small increments, feel free. If you prefer a tidier PR history, force-pushes are welcome (for example, to squash or reorder commits before review). Just avoid rewriting history in a way that makes it hard for reviewers to follow along. + +## Conventional Commits (required for PR titles) + +Because the PR title becomes the squash commit message, we require Conventional Commits for PR titles. + +We prefer type/subject to be mostly lowercase. + +Format: + +- `type(scope optional): short description` + +Examples: + +- `fix: handle empty response from api` +- `feat(auth): add passkey login` +- `docs: clarify dev workflow` +- `refactor: simplify retry logic` +- `chore(ci): speed up checks` + +Breaking changes: + +- `feat!: remove legacy auth endpoints` +- `refactor(api)!: change pagination shape` + +Common types: +`feat`, `fix`, `docs`, `refactor`, `perf`, `test`, `chore`, `ci`, `build`, `revert` + +## Tests (guidance) + +We care about confidence more than ceremony. Add tests when they provide real value. + +Tests run in GitHub Actions CI only (they require a PostgreSQL service container). You cannot run them locally. + +### Backend changes + +For backend changes that add or modify operational features, add a unit test. + +- Test files live alongside the code they test (e.g. `src/routers/__tests__/`) +- If a unit test would require heavy mocking to be meaningful, restructure the code so it can be tested cleanly through its interfaces +- If you're unsure how to approach this, discuss it with a maintainer before investing time + +### Frontend changes + +We don't generally encourage new unit tests for frontend code unless: + +- the area already has unit tests, or +- the change is complex or sensitive, and a unit test clearly reduces risk + +Pure UI/cosmetic changes (CSS tweaks, layout adjustments) do not require unit tests. In most cases, clear PR notes and practical verification are more valuable. + +## Formatting and linting + +Don't block on formatting or linting before opening a PR. CI enforces required checks and will tell you what needs fixing before merge. + +Open the PR when it's ready for review, then iterate based on CI and feedback. + +## PR checklist + +Before requesting review: + +- [ ] PR targets `dev` +- [ ] PR title follows Conventional Commits (mostly lowercase) +- [ ] PR includes a short description of what/why +- [ ] You understand every change in the PR and can explain it during review +- [ ] Tests added or updated where it makes sense (especially backend changes) +- [ ] CI is green (or you're actively addressing failures) + +Optional but helpful: + +- screenshots or a short recording for UI changes +- manual verification steps + +## Security + +Please don't report security issues via public GitHub issues. + +Instead, use GitHub's private vulnerability reporting: + +- Go to the [Security tab](https://github.com/plsechat/pulse-chat/security) of the repository and select "Report a vulnerability" + +## License + +By contributing to Pulse, you agree that your contributions will be licensed under the [GNU Affero General Public License v3.0](./LICENSE). diff --git a/Caddyfile b/Caddyfile new file mode 100644 index 0000000..9f5936a --- /dev/null +++ b/Caddyfile @@ -0,0 +1,5 @@ +chat.serverbob.org { + encode gzip + reverse_proxy pulse:4991 + tls zax@serverbob.org +} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..2b12cff --- /dev/null +++ b/Dockerfile @@ -0,0 +1,17 @@ +# Stage 1: Build +FROM oven/bun:1.3.5 AS builder +WORKDIR /app +COPY . . +RUN bun install +RUN cd apps/server \ + && bun run /app/docker/patch-migrations.ts ./src/db/migrations +RUN cd apps/server && bun run build/build.ts --target linux-x64 + +# Stage 2: Runtime +FROM oven/bun:1.3.5 +COPY --from=builder /app/apps/server/build/out/pulse-linux-x64 /pulse +COPY --from=builder /app/docker/pulse-entrypoint.sh /entrypoint.sh +ENV RUNNING_IN_DOCKER=true + +RUN chmod +x /pulse /entrypoint.sh +ENTRYPOINT ["/entrypoint.sh"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README-CUSTOM.md b/README-CUSTOM.md new file mode 100644 index 0000000..d66a61d --- /dev/null +++ b/README-CUSTOM.md @@ -0,0 +1,18 @@ +# Pulse Custom Voice Stack + +This repository is a sanitized snapshot of a working Pulse setup with custom microphone processing support. + +Included: +- Pulse source tree snapshot from `/opt/pulse` +- Custom install/patch scripts in `scripts/` +- DeepFilterNet/RNNoise-related client+server changes currently present in the source snapshot + +Excluded for safety/portability: +- `.env` +- runtime `data/` and `data-test/` +- original `.git` metadata from upstream clone + +## Quick start +1. Copy your `.env` into this repo root. +2. Build/run with your compose workflow. +3. Use scripts in `scripts/` for automated setup flows. diff --git a/README-SELFHOSTED-SUPABASE.md b/README-SELFHOSTED-SUPABASE.md new file mode 100644 index 0000000..481c884 --- /dev/null +++ b/README-SELFHOSTED-SUPABASE.md @@ -0,0 +1,500 @@ +# Self-Hosted Supabase Installation Guide + +This guide walks you through deploying Pulse with a fully self-hosted Supabase stack (PostgreSQL + GoTrue + Kong) using Docker Compose. No external Supabase project required. + +--- + +## Table of Contents + +1. [System Requirements](#system-requirements) +2. [Prerequisites](#prerequisites) +3. [Install Docker](#install-docker) +4. [Install Bun](#install-bun) +5. [Clone the Repository](#clone-the-repository) +6. [Generate Secrets](#generate-secrets) +7. [Configure Environment](#configure-environment) +8. [Build and Start](#build-and-start) +9. [Set Up HTTPS](#set-up-https) +10. [Firewall Configuration](#firewall-configuration) +11. [Claim Server Ownership](#claim-server-ownership) +12. [Verify Installation](#verify-installation) +13. [Updating Pulse](#updating-pulse) +14. [OAuth Setup (Optional)](#oauth-setup-optional) +15. [Federation Setup (Optional)](#federation-setup-optional) +16. [Troubleshooting](#troubleshooting) + +--- + +## System Requirements + +| Resource | Minimum | Recommended | +|----------|---------|-------------| +| CPU | 2 cores | 4 cores | +| RAM | 2 GB | 4 GB | +| Disk | 10 GB | 20 GB+ (depends on file uploads) | +| OS | Ubuntu 22.04 LTS | Ubuntu 24.04 LTS | +| Network | Public IP | Public IP + domain name | + +This deployment runs four Docker containers: PostgreSQL, GoTrue (auth), Kong (API gateway), and the Pulse application. + +--- + +## Prerequisites + +- A server with Ubuntu 22.04+ and root/sudo access +- A domain name with an A record pointing to your server's public IP (for HTTPS) +- SSH access to your server +- Git installed (`sudo apt install git` if not already present) + +--- + +## Install Docker + +```bash +# Update system packages +sudo apt update && sudo apt upgrade -y + +# Install required packages +sudo apt install -y ca-certificates curl gnupg + +# Add Docker's official GPG key +sudo install -m 0755 -d /etc/apt/keyrings +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg +sudo chmod a+r /etc/apt/keyrings/docker.gpg + +# Add Docker repository +echo \ + "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \ + $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ + sudo tee /etc/apt/sources.list.d/docker.list > /dev/null + +# Install Docker Engine + Compose +sudo apt update +sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin + +# Add your user to the docker group +sudo usermod -aG docker $USER +newgrp docker + +# Verify +docker --version +docker compose version +``` + +--- + +## Install Bun + +Bun is needed to run the key generator script: + +```bash +curl -fsSL https://bun.sh/install | bash +source ~/.bashrc +bun --version +``` + +--- + +## Clone the Repository + +```bash +sudo mkdir -p /opt/pulse +sudo chown $USER:$USER /opt/pulse +git clone https://github.com/plsechat/pulse-chat.git /opt/pulse +cd /opt/pulse +``` + +--- + +## Generate Secrets + +Generate a JWT secret and two Supabase API keys: + +```bash +cd /opt/pulse +bun docker/generate-keys.ts +``` + +Output: +``` +JWT_SECRET= +SUPABASE_ANON_KEY= +SUPABASE_SERVICE_ROLE_KEY= +``` + +**Copy all three values** for the next step. + +--- + +## Configure Environment + +```bash +cp .env.supabase.example .env +nano .env +``` + +Fill in the values: + +```env +# PostgreSQL password — strong and URL-safe (no / = + characters) +POSTGRES_PASSWORD=ChangeMeToSomethingSecure123 + +# Paste the three values from generate-keys.ts +JWT_SECRET= +SUPABASE_ANON_KEY= +SUPABASE_SERVICE_ROLE_KEY= + +# Your public domain (must match your DNS A record) +SITE_URL=https://your-domain.com +``` + +> **Important:** +> - `POSTGRES_PASSWORD` must be URL-safe. Avoid `/`, `=`, `+`, and other special characters. +> - `SITE_URL` must start with `https://` for production. +> - The `JWT_SECRET` generated by `generate-keys.ts` already meets the 32-character minimum. + +### Environment Variable Reference + +| Variable | Required | Default | Description | +|----------|----------|---------|-------------| +| `POSTGRES_PASSWORD` | Yes | — | Password for PostgreSQL | +| `JWT_SECRET` | Yes | — | Secret key for signing JWTs (min 32 chars) | +| `SUPABASE_ANON_KEY` | Yes | — | Supabase public/anonymous API key | +| `SUPABASE_SERVICE_ROLE_KEY` | Yes | — | Supabase admin service role key | +| `SITE_URL` | Yes | — | Public URL (e.g., `https://pulse.example.com`) | +| `PULSE_PORT` | No | `4991` | Host port for Pulse | +| `JWT_EXPIRY` | No | `3600` | Token expiry in seconds | +| `PUBLIC_IP` | No | auto | Public IP for WebRTC | +| `GOOGLE_OAUTH_ENABLED` | No | `false` | Enable Google login | +| `GOOGLE_OAUTH_CLIENT_ID` | No | — | Google OAuth client ID | +| `GOOGLE_OAUTH_SECRET` | No | — | Google OAuth client secret | +| `DISCORD_OAUTH_ENABLED` | No | `false` | Enable Discord login | +| `DISCORD_OAUTH_CLIENT_ID` | No | — | Discord OAuth client ID | +| `DISCORD_OAUTH_SECRET` | No | — | Discord OAuth client secret | +| `FACEBOOK_OAUTH_ENABLED` | No | `false` | Enable Facebook login | +| `FACEBOOK_OAUTH_CLIENT_ID` | No | — | Facebook OAuth client ID | +| `FACEBOOK_OAUTH_SECRET` | No | — | Facebook OAuth client secret | +| `TWITCH_OAUTH_ENABLED` | No | `false` | Enable Twitch login | +| `TWITCH_OAUTH_CLIENT_ID` | No | — | Twitch OAuth client ID | +| `TWITCH_OAUTH_SECRET` | No | — | Twitch OAuth client secret | +| `ADDITIONAL_REDIRECT_URLS` | No | — | Extra OAuth callback URLs | +| `REGISTRATION_DISABLED` | No | `false` | Block new registrations (existing users can still log in; valid invite codes bypass) | +| `GIPHY_API_KEY` | No | — | Giphy API key for GIF search | + +--- + +## Build and Start + +```bash +cd /opt/pulse +docker compose -f docker-compose-supabase.yml up -d +``` + +The first launch takes a few minutes while Docker downloads the required images. + +### Verify containers are running + +```bash +docker compose -f docker-compose-supabase.yml ps +``` + +You should see four containers, all `Up`: + +``` +NAME IMAGE STATUS +pulse-db supabase/postgres:15.6.1.143 Up (healthy) +pulse-auth supabase/gotrue:v2.170.0 Up +pulse-kong kong:3.4 Up +pulse pulse-pulse Up +``` + +### Check logs + +```bash +docker logs pulse +``` + +### Test the health endpoint + +```bash +curl http://localhost:4991/healthz +``` + +Should return `{"status":"ok","timestamp":...}`. + +--- + +## Set Up HTTPS + +Pulse does not handle TLS itself. Use a reverse proxy for HTTPS. + +### Option A: Caddy (recommended) + +```bash +sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https +curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg +curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list +sudo apt update +sudo apt install caddy +``` + +Configure `/etc/caddy/Caddyfile`: + +``` +your-domain.com { + handle /auth/v1/* { + reverse_proxy localhost:8000 + } + handle { + reverse_proxy localhost:4991 + } +} +``` + +```bash +sudo systemctl restart caddy +sudo systemctl enable caddy +``` + +Caddy automatically obtains and renews Let's Encrypt certificates. + +### Option B: Nginx + +```bash +sudo apt install nginx certbot python3-certbot-nginx +``` + +Create `/etc/nginx/sites-available/pulse`: + +```nginx +server { + server_name your-domain.com; + + location /auth/v1/ { + proxy_pass http://127.0.0.1:8000; + proxy_http_version 1.1; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + } + + location / { + proxy_pass http://127.0.0.1:4991; + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_read_timeout 86400; + } +} +``` + +```bash +sudo ln -s /etc/nginx/sites-available/pulse /etc/nginx/sites-enabled/ +sudo rm /etc/nginx/sites-enabled/default +sudo nginx -t +sudo systemctl restart nginx +sudo certbot --nginx -d your-domain.com +``` + +--- + +## Firewall Configuration + +```bash +sudo ufw allow 22/tcp # SSH +sudo ufw allow 80/tcp # HTTP +sudo ufw allow 443/tcp # HTTPS +sudo ufw allow 40000:40020/udp # WebRTC voice/video +sudo ufw allow 40000:40020/tcp # WebRTC TCP fallback +sudo ufw enable +``` + +| Port | Protocol | Purpose | +|------|----------|---------| +| 22 | TCP | SSH access | +| 80 | TCP | HTTP (redirects to HTTPS) | +| 443 | TCP | HTTPS (web + WebSocket) | +| 4991 | TCP | Pulse (only if no reverse proxy) | +| 40000-40020 | UDP + TCP | WebRTC media (voice/video/screen share) | + +> **Note:** Docker manipulates iptables directly and can bypass ufw rules. Ports mapped in `docker-compose-supabase.yml` may be publicly accessible even if ufw doesn't allow them. The compose file binds Kong (port 8000) to `127.0.0.1` so it is only accessible from the reverse proxy — do not change this to `0.0.0.0`. + +--- + +## Claim Server Ownership + +1. Open `https://your-domain.com` in your browser +2. Register a new account +3. Find the ownership token in the server logs: + +```bash +docker logs pulse 2>&1 | grep -i token +``` + +4. In the Pulse web interface, open browser DevTools (F12) +5. Go to the Console tab and run: `useToken('your_token_here')` +6. Your account is now the server owner + +> The ownership token is printed once on first start. Save it somewhere secure. + +--- + +## Verify Installation + +- [ ] `https://your-domain.com` loads the login page +- [ ] You can register and log in +- [ ] You claimed ownership with the token +- [ ] Text channels work (send/receive messages) +- [ ] File uploads work +- [ ] Voice channels work (join, speak, hear others) +- [ ] `docker compose -f docker-compose-supabase.yml ps` shows all 4 containers healthy + +--- + +## Updating Pulse + +```bash +cd /opt/pulse +docker compose -f docker-compose-supabase.yml pull +docker compose -f docker-compose-supabase.yml up -d +``` + +This pulls the latest published image and restarts the containers. Database migrations are handled automatically on startup. + +--- + +## OAuth Setup (Optional) + +Pulse supports OAuth login via Google, Discord, Facebook, and Twitch through GoTrue. All OAuth configuration is done through your `.env` file — do not edit `docker-compose-supabase.yml` directly. + +### Google OAuth + +1. Go to [Google Cloud Console](https://console.cloud.google.com/) +2. Create a project and go to **APIs & Services > Credentials** +3. Create an **OAuth 2.0 Client ID** (Web application) +4. Set the authorized redirect URI to: `https://your-domain.com/auth/v1/callback` +5. Add to your `.env`: + +```env +GOOGLE_OAUTH_ENABLED=true +GOOGLE_OAUTH_CLIENT_ID=your-client-id +GOOGLE_OAUTH_SECRET=your-client-secret +``` + +6. Restart: `docker compose -f docker-compose-supabase.yml up -d` + +### Discord OAuth + +1. Go to [Discord Developer Portal](https://discord.com/developers/applications) +2. Create an application, go to **OAuth2**, add redirect: `https://your-domain.com/auth/v1/callback` +3. Add to your `.env`: + +```env +DISCORD_OAUTH_ENABLED=true +DISCORD_OAUTH_CLIENT_ID=your-client-id +DISCORD_OAUTH_SECRET=your-client-secret +``` + +4. Restart: `docker compose -f docker-compose-supabase.yml up -d` + +The same pattern applies for Facebook and Twitch — replace `DISCORD` with `FACEBOOK` or `TWITCH` in the variable names. + +--- + +## Federation Setup (Optional) + +Federation lets multiple Pulse instances connect so users can discover and join servers across instances. + +1. Edit the config file: + +```bash +nano data/pulse/config.ini +``` + +2. Add or modify: + +```ini +[federation] +enabled=true +domain=your-domain.com +``` + +3. Restart: + +```bash +docker compose -f docker-compose-supabase.yml restart pulse +``` + +### Connect Two Instances + +On Instance A: Go to **Server Settings > Federation** > **Generate Keys** > **Add Instance** (enter Instance B's domain). + +On Instance B: **Server Settings > Federation** > **Generate Keys** > Accept Instance A's request. + +--- + +## Troubleshooting + +### Containers won't start + +```bash +docker logs pulse-db +docker logs pulse-auth +docker logs pulse-kong +docker logs pulse +``` + +Common issues: +- **pulse-db**: `POSTGRES_PASSWORD` contains special characters. Use only alphanumeric characters. +- **pulse-auth**: Database connection failed. Check `db` container is healthy: `docker compose -f docker-compose-supabase.yml ps` +- **pulse-kong**: Config error. Verify `docker/kong-supabase.yml` is valid YAML. + +### GoTrue auth fails + +```bash +docker exec pulse curl -s http://kong:8000/auth/v1/health +``` + +The `supabase_auth_admin` password is synced automatically on every container start via `docker/db-entrypoint.sh`. If you change `POSTGRES_PASSWORD` in your `.env`, just restart: + +```bash +docker compose -f docker-compose-supabase.yml up -d +``` + +The DB container will re-sync the password automatically. + +### WebRTC voice/video not working + +1. Check UDP ports are open: `sudo ufw status | grep 40000` +2. Check Docker port mapping: `docker port pulse` +3. If behind NAT, forward ports 40000-40020/UDP from your router +4. Check public IP detection: `docker logs pulse 2>&1 | grep -i "public ip"` + +### Database issues + +```bash +docker exec -it pulse-db psql -U postgres +\dt +SELECT pg_size_pretty(pg_database_size('postgres')); +``` + +### Reset everything + +```bash +cd /opt/pulse +docker compose -f docker-compose-supabase.yml down -v +rm -rf data/ +docker compose -f docker-compose-supabase.yml up -d +``` + +### View real-time logs + +```bash +docker compose -f docker-compose-supabase.yml logs -f +docker compose -f docker-compose-supabase.yml logs -f pulse +``` diff --git a/README.md b/README.md new file mode 100644 index 0000000..93852f8 --- /dev/null +++ b/README.md @@ -0,0 +1,110 @@ +

+ Pulse Chat +

+ +

Pulse Chat

+ +

+ A self-hosted chat platform built for privacy, voice, and connecting communities. +
+ plse.chat · + Self-Hosting Guide · + Releases +

+ +

+ License + Last Commit +

+ + + +--- + +> [!NOTE] +> Pulse Chat is in alpha (v0.1.3). Expect bugs and breaking changes between updates. + +## Why Pulse? + +Pulse is a self-hosted alternative to Discord and Slack that puts you in control. Every message can be end-to-end encrypted, voice and video stay on your infrastructure, and federation lets separate instances talk to each other — no central service required. + +## What's included + +| | | +|---|---| +| **Encrypted messaging** | Signal Protocol (X3DH + Double Ratchet) for DMs and channels | +| **Voice & video** | WebRTC-powered calls with screen sharing via Mediasoup | +| **Federation** | Link multiple Pulse instances so users can discover and join across servers | +| **Forum channels** | Threaded discussions with tags for long-form topics | +| **Channels & DMs** | Real-time text with file uploads, reactions, threads, and mentions | +| **Roles & permissions** | Granular access control at the server, channel, and user level | +| **Custom emojis** | Upload and manage emojis per server | +| **Automod** | Keyword filters, regex rules, mention limits, and link blocking | +| **Webhooks** | Push events to external services | +| **OAuth login** | Google, Discord, Facebook, Twitch — toggle each on or off | +| **Invite-only mode** | Lock down registration so only invited users can join | + +## Getting started + +Pulse needs a Supabase backend (auth + database). You can use [Supabase Cloud](https://supabase.com) or self-host everything together — see the [Self-Hosted Guide](README-SELFHOSTED-SUPABASE.md) for the full Docker Compose setup with PostgreSQL, GoTrue, and Kong. + +### Docker + +```bash +docker run \ + -p 4991:4991/tcp \ + -p 40000-40020:40000-40020/tcp \ + -p 40000-40020:40000-40020/udp \ + -v ./data:/root/.config/pulse \ + --name pulse \ + ghcr.io/plsechat/pulse-chat:latest +``` + +For production with Supabase bundled, use [docker-compose-supabase.yml](docker-compose-supabase.yml) from the [Self-Hosted Guide](README-SELFHOSTED-SUPABASE.md). + +### Linux binary + +```bash +curl -L https://github.com/plsechat/pulse-chat/releases/latest/download/pulse-linux-x64 -o pulse +chmod +x pulse +./pulse +``` + +### After first launch + +1. Open `http://localhost:4991` +2. A **security token** prints to the server console on first run — save it +3. Register and log in +4. Claim ownership: open the browser console and run `useToken('your_token_here')` + +## Configuration + +A config file is generated at `~/.config/pulse/config.ini` on first run. + +| Section | Key | Default | What it does | +|---|---|---|---| +| server | `port` | `4991` | HTTP / WebSocket port | +| server | `debug` | `false` | Verbose logging | +| server | `autoupdate` | `false` | Auto-check for updates | +| http | `maxFiles` | `40` | Max files per upload | +| http | `maxFileSize` | `100` | Max file size (MB) | +| mediasoup | `worker.rtcMinPort` | `40000` | WebRTC port range start | +| mediasoup | `worker.rtcMaxPort` | `40020` | WebRTC port range end | +| mediasoup | `video.initialAvailableOutgoingBitrate` | `6000000` | Bandwidth per stream (bps) | +| federation | `enabled` | `false` | Turn on federation | +| federation | `domain` | — | Your public domain (required for federation) | + +> [!IMPORTANT] +> The port range `rtcMinPort`–`rtcMaxPort` controls how many concurrent voice/video connections are possible. Each connection uses one UDP port. Open these ports (TCP + UDP) in your firewall, and map the range in Docker if applicable. + +## HTTPS + +Pulse doesn't terminate TLS. Put a reverse proxy in front — Caddy, Nginx, or Traefik all work. The [Self-Hosted Guide](README-SELFHOSTED-SUPABASE.md#set-up-https) has example configs for Caddy and Nginx. + +## Built with + +[Bun](https://bun.sh) · [React](https://react.dev) · [tRPC](https://trpc.io) · [Drizzle ORM](https://orm.drizzle.team) · [Mediasoup](https://mediasoup.org) · [Tailwind CSS](https://tailwindcss.com) · [Supabase](https://supabase.com) · [Signal Protocol](https://signal.org/docs/) + +## License + +[AGPL-3.0](LICENSE) diff --git a/apps/client/.gitignore b/apps/client/.gitignore new file mode 100644 index 0000000..a547bf3 --- /dev/null +++ b/apps/client/.gitignore @@ -0,0 +1,24 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* +lerna-debug.log* + +node_modules +dist +dist-ssr +*.local + +# Editor directories and files +.vscode/* +!.vscode/extensions.json +.idea +.DS_Store +*.suo +*.ntvs* +*.njsproj +*.sln +*.sw? diff --git a/apps/client/.prettierrc.json b/apps/client/.prettierrc.json new file mode 100644 index 0000000..7981412 --- /dev/null +++ b/apps/client/.prettierrc.json @@ -0,0 +1,11 @@ +{ + "singleQuote": true, + "printWidth": 80, + "proseWrap": "always", + "tabWidth": 2, + "useTabs": false, + "trailingComma": "none", + "bracketSpacing": true, + "semi": true, + "plugins": ["prettier-plugin-organize-imports"] +} diff --git a/apps/client/components.json b/apps/client/components.json new file mode 100644 index 0000000..bde9f61 --- /dev/null +++ b/apps/client/components.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://ui.shadcn.com/schema.json", + "style": "new-york", + "rsc": false, + "tsx": true, + "tailwind": { + "config": "", + "css": "src/index.css", + "baseColor": "neutral", + "cssVariables": true, + "prefix": "" + }, + "iconLibrary": "lucide", + "aliases": { + "components": "@/components", + "utils": "@/lib/utils", + "ui": "@/components/ui", + "lib": "@/lib", + "hooks": "@/hooks" + }, + "registries": { + "@shadcn-editor": "https://shadcn-editor.vercel.app/r/{name}.json" + } +} diff --git a/apps/client/eslint.config.js b/apps/client/eslint.config.js new file mode 100644 index 0000000..d61eb90 --- /dev/null +++ b/apps/client/eslint.config.js @@ -0,0 +1,43 @@ +import js from '@eslint/js'; +import reactHooks from 'eslint-plugin-react-hooks'; +import reactRefresh from 'eslint-plugin-react-refresh'; +import reactYouMightNotNeedAnEffect from 'eslint-plugin-react-you-might-not-need-an-effect'; +import unusedImports from 'eslint-plugin-unused-imports'; +import { defineConfig, globalIgnores } from 'eslint/config'; +import globals from 'globals'; +import tseslint from 'typescript-eslint'; + +export default defineConfig([ + globalIgnores(['dist']), + { + files: ['**/*.{ts,tsx}'], + extends: [js.configs.recommended, ...tseslint.configs.recommended], + languageOptions: { + ecmaVersion: 2020, + globals: globals.browser + }, + plugins: { + 'react-hooks': reactHooks, + 'react-refresh': reactRefresh, + 'unused-imports': unusedImports, + 'react-you-might-not-need-an-effect': reactYouMightNotNeedAnEffect + }, + rules: { + ...reactHooks.configs.recommended.rules, + ...reactRefresh.configs.recommended.rules, + 'no-unused-vars': 'off', + '@typescript-eslint/no-unused-vars': 'off', + 'unused-imports/no-unused-imports': 'error', + 'unused-imports/no-unused-vars': [ + 'warn', + { + vars: 'all', + varsIgnorePattern: '^_', + args: 'after-used', + argsIgnorePattern: '^_' + } + ], + 'react-refresh/only-export-components': 'warn' + } + } +]); diff --git a/apps/client/index.html b/apps/client/index.html new file mode 100644 index 0000000..d8a0ed0 --- /dev/null +++ b/apps/client/index.html @@ -0,0 +1,18 @@ + + + + + + + + + + Pulse + + +
+
+
+ + + diff --git a/apps/client/package.json b/apps/client/package.json new file mode 100644 index 0000000..c9ec3ff --- /dev/null +++ b/apps/client/package.json @@ -0,0 +1,101 @@ +{ + "name": "client", + "private": true, + "version": "0.1.7", + "type": "module", + "scripts": { + "dev": "vite", + "build": "vite build", + "lint": "eslint ./src --ext ts,tsx", + "lint:fix": "eslint ./src --ext ts,tsx --report-unused-disable-directives --fix", + "check-types": "tsc --noEmit --project tsconfig.app.json", + "format": "prettier --write \"**/*.ts*\" --config ./.prettierrc.json", + "magic": "bun --bun run lint:fix && bun --bun run format && bun --bun run check-types" + }, + "dependencies": { + "@dnd-kit/core": "^6.3.1", + "@dnd-kit/sortable": "^10.0.0", + "@dnd-kit/utilities": "^3.2.2", + "@emoji-mart/data": "^1.2.1", + "@emoji-mart/react": "^1.1.1", + "@floating-ui/dom": "^1.7.4", + "@privacyresearch/libsignal-protocol-typescript": "^0.0.16", + "@pulse/shared": "workspace:*", + "@radix-ui/react-alert-dialog": "^1.1.15", + "@radix-ui/react-avatar": "^1.1.10", + "@radix-ui/react-context-menu": "^2.2.16", + "@radix-ui/react-dialog": "^1.1.15", + "@radix-ui/react-dropdown-menu": "^2.1.16", + "@radix-ui/react-label": "^2.1.7", + "@radix-ui/react-popover": "^1.1.15", + "@radix-ui/react-select": "^2.2.6", + "@radix-ui/react-separator": "^1.1.8", + "@radix-ui/react-slider": "^1.3.6", + "@radix-ui/react-slot": "^1.2.4", + "@radix-ui/react-switch": "^1.2.6", + "@radix-ui/react-tabs": "^1.1.13", + "@radix-ui/react-tooltip": "^1.2.8", + "@reduxjs/toolkit": "^2.9.0", + "@supabase/supabase-js": "^2.49.1", + "@tailwindcss/vite": "^4.1.13", + "@tiptap/core": "^3.7.2", + "@tiptap/extension-emoji": "^3.7.2", + "@tiptap/extension-placeholder": "^3.20.0", + "@tiptap/pm": "^3.7.2", + "@tiptap/react": "^3.7.2", + "@tiptap/starter-kit": "^3.7.2", + "@tiptap/suggestion": "^3.7.2", + "@trpc/client": "^11.6.0", + "@types/lodash-es": "^4.17.12", + "class-variance-authority": "^0.7.1", + "clsx": "^2.1.1", + "cmdk": "^1.0.0", + "date-fns": "^4.1.0", + "dompurify": "^3.2.4", + "emoji-mart": "^5.6.0", + "eslint-plugin-react-you-might-not-need-an-effect": "^0.7.0", + "filesize": "^11.0.13", + "highlight.js": "^11.11.1", + "html-react-parser": "^5.2.6", + "idb": "^8.0.3", + "lodash-es": "^4.17.21", + "lucide-react": "^0.544.0", + "mediasoup-client": "^3.18.0", + "next-themes": "^0.4.6", + "prosemirror-view": "^1.38.1", + "re-reselect": "^5.1.0", + "react": "^19.1.1", + "react-colorful": "^5.6.1", + "react-day-picker": "^9.11.1", + "react-dom": "^19.1.1", + "react-lite-youtube-embed": "^2.5.6", + "react-redux": "^9.2.0", + "react-resizable-panels": "^4.6.5", + "react-tweet": "^3.2.2", + "react-virtuoso": "^4.18.1", + "sonner": "^2.0.7", + "tailwind-merge": "^3.3.1", + "tailwindcss": "^4.1.13", + "@timephy/rnnoise-wasm": "^1.0.0", + "deepfilternet3-noise-filter": "^1.2.1" + }, + "devDependencies": { + "@eslint/js": "^9.36.0", + "@types/dompurify": "^3.2.0", + "@types/node": "^24.5.2", + "@types/react": "^19.1.13", + "@types/react-dom": "^19.1.9", + "@vitejs/plugin-react-swc": "^4.1.0", + "eslint": "^9.36.0", + "eslint-plugin-react-hooks": "^5.2.0", + "eslint-plugin-react-refresh": "^0.4.20", + "eslint-plugin-unused-imports": "^4.1.4", + "globals": "^16.4.0", + "tw-animate-css": "^1.4.0", + "typescript": "~5.8.3", + "typescript-eslint": "^8.44.0", + "vite": "^7.1.7", + "prettier": "^3.4.2", + "prettier-plugin-organize-imports": "^4.0.0" + } +} diff --git a/apps/client/public/favicon.ico b/apps/client/public/favicon.ico new file mode 100644 index 0000000..ee66fab Binary files /dev/null and b/apps/client/public/favicon.ico differ diff --git a/apps/client/public/logo.png b/apps/client/public/logo.png new file mode 100644 index 0000000..3524f50 Binary files /dev/null and b/apps/client/public/logo.png differ diff --git a/apps/client/public/logo.webp b/apps/client/public/logo.webp new file mode 100644 index 0000000..ea02b4a Binary files /dev/null and b/apps/client/public/logo.webp differ diff --git a/apps/client/src/components/channel-view/forum/create-forum-post-dialog.tsx b/apps/client/src/components/channel-view/forum/create-forum-post-dialog.tsx new file mode 100644 index 0000000..4efe468 --- /dev/null +++ b/apps/client/src/components/channel-view/forum/create-forum-post-dialog.tsx @@ -0,0 +1,291 @@ +import { Button } from '@/components/ui/button'; +import { getTRPCClient } from '@/lib/trpc'; +import { setActiveThreadId } from '@/features/server/channels/actions'; +import { uploadFiles } from '@/helpers/upload-file'; +import { Image, Plus, X } from 'lucide-react'; +import { memo, useCallback, useEffect, useRef, useState } from 'react'; +import { toast } from 'sonner'; + +type TCreateForumPostDialogProps = { + channelId: number; + onClose: () => void; +}; + +type TTag = { + id: number; + name: string; + color: string; +}; + +type TUploadedFile = { + tempId: string; + originalName: string; + previewUrl: string | null; + isImage: boolean; +}; + +const IMAGE_EXTENSIONS = new Set([ + 'jpg', + 'jpeg', + 'png', + 'gif', + 'webp', + 'svg', + 'bmp', + 'ico' +]); + +const CreateForumPostDialog = memo( + ({ channelId, onClose }: TCreateForumPostDialogProps) => { + const [title, setTitle] = useState(''); + const [content, setContent] = useState(''); + const [tags, setTags] = useState([]); + const [selectedTagIds, setSelectedTagIds] = useState([]); + const [submitting, setSubmitting] = useState(false); + const [uploadedFiles, setUploadedFiles] = useState([]); + const [uploading, setUploading] = useState(false); + const fileInputRef = useRef(null); + + useEffect(() => { + const fetchTags = async () => { + const trpc = getTRPCClient(); + + try { + const result = await trpc.threads.getForumTags.query({ channelId }); + setTags(result); + } catch { + // ignore + } + }; + + fetchTags(); + }, [channelId]); + + const toggleTag = useCallback((tagId: number) => { + setSelectedTagIds((prev) => + prev.includes(tagId) + ? prev.filter((id) => id !== tagId) + : [...prev, tagId] + ); + }, []); + + const onFileInputChange = useCallback( + async (e: React.ChangeEvent) => { + const selectedFiles = Array.from(e.target.files ?? []); + if (selectedFiles.length === 0) return; + + setUploading(true); + + try { + const uploaded = await uploadFiles(selectedFiles); + const newFiles: TUploadedFile[] = uploaded.map((tempFile, i) => { + const isImage = IMAGE_EXTENSIONS.has( + tempFile.extension.toLowerCase() + ); + const originalFile = selectedFiles[i]; + const previewUrl = + isImage && originalFile + ? URL.createObjectURL(originalFile) + : null; + + return { + tempId: tempFile.id, + originalName: tempFile.originalName, + previewUrl, + isImage + }; + }); + setUploadedFiles((prev) => [...prev, ...newFiles]); + } catch { + toast.error('Failed to upload file'); + } finally { + setUploading(false); + e.target.value = ''; + } + }, + [] + ); + + const removeFile = useCallback((id: string) => { + setUploadedFiles((prev) => { + const file = prev.find((f) => f.tempId === id); + if (file?.previewUrl) URL.revokeObjectURL(file.previewUrl); + return prev.filter((f) => f.tempId !== id); + }); + }, []); + + const onSubmit = useCallback(async () => { + if (!title.trim() || !content.trim() || submitting) return; + + setSubmitting(true); + + const trpc = getTRPCClient(); + + try { + const result = await trpc.threads.createForumPost.mutate({ + channelId, + title: title.trim(), + content: content.trim(), + tagIds: selectedTagIds.length > 0 ? selectedTagIds : undefined, + files: + uploadedFiles.length > 0 + ? uploadedFiles.map((f) => f.tempId) + : undefined + }); + + setActiveThreadId(result.threadId); + toast.success('Post created'); + onClose(); + } catch { + toast.error('Failed to create post'); + } finally { + setSubmitting(false); + } + }, [ + title, + content, + channelId, + selectedTagIds, + uploadedFiles, + submitting, + onClose + ]); + + return ( +
+
+
+

New Post

+ +
+ +
+
+ setTitle(e.target.value)} + placeholder="Post title" + className="w-full px-3 py-2 text-sm bg-muted/30 border border-border/50 rounded-md focus:outline-none focus:ring-1 focus:ring-primary/30" + maxLength={200} + autoFocus + /> +
+ +
+