Update README, switch Render deployment to FastAPI backend#2
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates deployment/docs to reflect the migration from the legacy Flask app to a FastAPI (backend) + Next.js (frontend) stack, with Render hosting the backend and Vercel hosting the frontend.
Changes:
- Rewrites
README.mdwith updated stack description, local development instructions, env var tables, and endpoint references. - Updates
render.yamlto deploy the FastAPI app frombackend/and refreshes environment variable configuration. - Adds
frontend/.env.local.exampleto document local frontend configuration.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| render.yaml | Switches Render deployment to the FastAPI backend under backend/ and updates start command/env vars. |
| README.md | Replaces Flask-era documentation with FastAPI + Next.js setup, env vars, endpoints, and deployment instructions. |
| frontend/.env.local.example | Provides an example NEXT_PUBLIC_API_URL for local frontend development. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| rootDir: backend | ||
| buildCommand: pip install -r requirements.txt | ||
| startCommand: gunicorn app:app | ||
| startCommand: gunicorn app.main:app --worker-class uvicorn.workers.UvicornWorker --workers 2 |
| |----------|---------|-------------| | ||
| | `GEMINI_API_KEY` | — | Required for AI features. Get one free at [aistudio.google.com](https://aistudio.google.com). | | ||
| | `GEMINI_MODEL` | `gemini-2.5-flash-lite` | Gemini model to use. | | ||
| | `SEARCH_LIMIT` | `50` | Max results per search query (1–200). | |
| | `/sitemap.xml` | XML | Public page sitemap. | | ||
| | Method | Route | Description | | ||
| |--------|-------|-------------| | ||
| | `GET` | `/api/search?q=<term>` | Search the dictionary. Returns up to 50 results. | |
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.
Summary
render.yamlfrom Flask root app to FastAPI backend inbackend/directoryfrontend/.env.local.examplefor local development setupWhat changed
README:
render.yaml:
rootDir: backend— Render now builds and serves the FastAPI appgunicorn app.main:app --worker-class uvicorn.workers.UvicornWorkerGEMINI_API_KEY,GEMINI_MODEL,SQLITE_PATHTest plan
feat/nextjs-frontendis merged (this branch builds on top of it)rootDirconfig/healthzreturns"version": "0.3.0"after deploy