Rename project to rssnook - #4
Draft
AdrienLF wants to merge 1 commit into
Draft
Conversation
Reviewer's GuideRenames the product and codebase from Readr to rssnook, adds migration/entrypoint logic and Compose tweaks to preserve existing deployments, improves Docker/nginx/dev tooling and accessibility, and introduces public-facing project docs plus CI/dependabot/security configuration for a 1.0.0-style release. Sequence diagram for legacy Readr to rssnook migration on startupsequenceDiagram
actor User
participant rssnook_command as rssnook.command
participant start_sh as start.sh
participant Docker as docker
participant Backend as backend_container
participant Entrypoint as entrypoint.sh
participant Uvicorn as uvicorn
User->>rssnook_command: open rssnook.command
rssnook_command->>start_sh: bash start.sh --build
start_sh->>Docker: docker ps (check legacy project readr)
alt legacy containers exist
start_sh->>Docker: docker compose -p readr down --remove-orphans
end
start_sh->>Docker: docker compose up -d [gpu or cpu]
Docker->>Backend: start backend service
Backend->>Entrypoint: rssnook-entrypoint
Entrypoint->>Entrypoint: check DATABASE_URL
Entrypoint->>Entrypoint: mv rss_reader.db -> rssnook.db
Entrypoint->>Entrypoint: chown -R appuser:appuser /app/data
Entrypoint->>Uvicorn: exec gosu appuser uvicorn app.main:app
Uvicorn-->>User: rssnook API available at /api/settings
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Why
This prepares the project for a public release under its permanent rssnook identity while preserving existing user data.
Validation
Summary by Sourcery
Rename the application, services, and assets to rssnook and prepare the project for public release while preserving existing installations.
New Features:
Enhancements:
Build:
CI:
Deployment:
Documentation:
Tests:
Chores: