[FEATURE]: Add a backend server so articles can be submitted from the website

Đang mở
#108 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
express, github, next.js, node.js, typescript

Hướng nghiên cứu

Start by reading the existing /submit page, lib/markdown-renderer.tsx, articles-index.json, and the GitHub Actions workflow to understand the current formats and deployment flow. Then decide where the separate API will run and how it will authenticate with GitHub; the issue leaves both decisions open. Done means validated submissions create a PR with the article, images, and a valid index entry, with clear errors and updated README and submission docs.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation enhancement
Feature and its Use Cases

Title: [Feature] Add a backend server so articles can be submitted from the website (no manual PR)

Problem

Contributors currently have to fork the repo, add a .md file and images, hand-edit articles-index.json and open a PR. This is a barrier for non-developers, and mistakes in the index (a bad comma, a slug that doesn't match the filename) break the build.

Proposal

Turn the submission flow into a small client-server app:

  • Client (existing Next.js site, /submit): a form with title, author, date, excerpt, header image, a Markdown editor with live preview (reusing lib/markdown-renderer.tsx) and image upload. It also does basic client-side validation.
  • Server (new Node.js/Express API, hosted separately): the site is a static export on GitHub Pages, so it can't handle uploads itself. The server:
    1. receives and re-validates the submission (fields, date format, image type/size, slug uniqueness),
    2. generates the slug and the articles-index.json entry (featured: false),
    3. uses the GitHub API to create a branch, commit the .md and images, and open a PR for maintainer review.
  • On merge, the existing GitHub Actions workflow deploys the site as it does now.

Key requirements

  • No GitHub account needed to submit.
  • Keep the current file and index format, so nothing else changes.
  • Enforce the existing image rules (JPG/PNG/WebP, max 2 MB, hyphenated lowercase names).
  • The GitHub token stays server-side only.
  • Rate limiting, CAPTCHA or honeypot, and sanitization of submitted content.
  • The manual PR route keeps working, and the docs are updated.

Open questions

  • Where should the server be hosted, and who owns the GitHub bot token or app?
  • Is it OK to keep maintainer review via PR as the approval step?

Acceptance criteria

  • A user can submit an article from /submit without using Git.
  • Submission creates a PR with the .md, images and a valid index entry.
  • Invalid input is rejected with clear errors.
  • README and /submit docs are updated.

I'd like to work on this if the approach looks good.

Code of Conduct
  • I have joined the Discord server and will post updates there
  • I have searched existing issues to avoid duplicates
Ngôn ngữ chính
TypeScript
Star
9
Fork
35
Merge trung bình
4 ngày 15 giờ
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của StabilityNexus/StableViewpoints

Tất cả issue của StabilityNexus/StableViewpoints

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.