{"id":46020825,"url":"https://github.com/willwillis/fast-api-scripture-app","last_synced_at":"2026-05-01T07:01:16.300Z","repository":{"id":302986347,"uuid":"1014052823","full_name":"willwillis/fast-api-scripture-app","owner":"willwillis","description":"A React + Vite / FastAPI Scripture App","archived":false,"fork":false,"pushed_at":"2025-11-18T05:07:49.000Z","size":2365,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-01T04:16:07.998Z","etag":null,"topics":["cicd","coverage-testing","fastapi","mit-license","python","react","uv","vite"],"latest_commit_sha":null,"homepage":"https://scriptures-frontend.onrender.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willwillis.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-05T00:42:40.000Z","updated_at":"2025-11-18T04:59:08.000Z","dependencies_parsed_at":"2025-07-05T15:31:21.850Z","dependency_job_id":null,"html_url":"https://github.com/willwillis/fast-api-scripture-app","commit_stats":null,"previous_names":["willwillis/fast-api-scripture-app"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/willwillis/fast-api-scripture-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willwillis%2Ffast-api-scripture-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willwillis%2Ffast-api-scripture-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willwillis%2Ffast-api-scripture-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willwillis%2Ffast-api-scripture-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willwillis","download_url":"https://codeload.github.com/willwillis/fast-api-scripture-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willwillis%2Ffast-api-scripture-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32487739,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cicd","coverage-testing","fastapi","mit-license","python","react","uv","vite"],"created_at":"2026-03-01T02:32:59.860Z","updated_at":"2026-05-01T07:01:16.286Z","avatar_url":"https://github.com/willwillis.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fast Scriptures\n\n[![CI](https://github.com/willwillis/fast-api-scripture-app/workflows/CI%2FCD%20Pipeline/badge.svg)](https://github.com/willwillis/fast-api-scripture-app/actions)\n[![codecov](https://codecov.io/gh/willwillis/fast-api-scripture-app/branch/main/graph/badge.svg)](https://codecov.io/gh/willwillis/fast-api-scripture-app)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)\n[![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=flat\u0026logo=fastapi)](https://fastapi.tiangolo.com)\n[![React](https://img.shields.io/badge/React-20232A?style=flat\u0026logo=react\u0026logoColor=61DAFB)](https://reactjs.org)\n\nA modern, mobile-first scripture reading application that makes exploring the LDS scriptures fast, beautiful, and accessible.\n\n![Scripture App Screenshot](./docs/screenshots/scriptures-app-screenshot.png)\n\n## 💪 Motivation\n- I wanted to kick the tires on Python's FastAPI and React (and what inspired the name `fast scriptures`)\n- I recently found `uv` for python and wanted to use it in a \"real world\" project, same for `Vite` on the front-end\n- I wanted a playground where I could run tests, use github actions, tinker with apm and observability\n- I wanted to keep my web development skills fresh\n\n## ✨ Features\n\n- Read the scriptures\n- Search the scriptures\n- Get a random scripture\n- open scripture API\n\n\n## 🚀 Getting Started\n\n### Welcome!\n\n👋 Whether you want to contribute, explore, or just run the app locally, we've got you covered:\n\n**[📖 Getting Started Guide](./docs/getting-started.md)** - Complete setup instructions and your first contribution\n\n**[📚 Documentation Hub](./docs/README.md)** - All documentation organized and (hopefully) easy to navigate\n\n### Quick Start\n\nWant to see it in action? Visit the live app: **[scriptures-fast-api.onrender.com](https://scriptures-fast-api.onrender.com)**\n\n### Quick Local Setup\n\n```bash\n# Clone and setup\ngit clone https://github.com/willwillis/fast-api-scripture-app.git\ncd fast-api-scripture-app\ngit submodule update --init --recursive\n\n# Backend (Terminal 1)\ncd backend \u0026\u0026 uv sync \u0026\u0026 python setup_database.py\nuv run uvicorn app.main:app --reload --host 0.0.0.0 --port 8000\n\n# Frontend (Terminal 2)\ncd frontend \u0026\u0026 npm install \u0026\u0026 npm run dev\n```\n\nVisit http://localhost:5173 to see your local version!\n\n## 🏗️ Architecture\n\nFast Scriptures is built with a modern, clean architecture:\n\n- **Frontend**: React 18 + TypeScript + Tailwind CSS + Vite\n- **Backend**: FastAPI + Python + SQLite\n- **Data**: LDS Scriptures database (as git submodule)\n- **Deployment**: Render (auto-deploy from main branch)\n- **CI/CD**: GitHub Actions with comprehensive testing\n\nSee our **[Architecture Overview](./docs/architecture.md)** *(coming soon)* for detailed system design.\n\n## 🤝 Contributing\n\nThis is a personal project, and the functinoality is a bit contrived, but if you want to contribute, here's how to get involved:\n\n1. **Start with our [Getting Started Guide](./docs/getting-started.md)** - Everything you need to know\n2. **Browse the [Documentation](./docs/README.md)** - Organized by what you want to do\n3. **Check [Issues](https://github.com/willwillis/fast-api-scripture-app/issues)** - Find something to work on\n4. **Join the conversation** - Create issues, ask questions, share ideas\n\n### Quick Contribution Flow\n```bash\ngit checkout -b your-feature-name\n# Make your changes\ngit commit -m \"feat: describe your change\"\ngit push -u origin your-feature-name\n# Create a Pull Request\n```\nOther ways to be involved:\n\n- **🐛 Report Issues**: [GitHub Issues](https://github.com/willwillis/fast-api-scripture-app/issues)\n- **💡 Feature Requests**: [GitHub Discussions](https://github.com/willwillis/fast-api-scripture-app/discussions)\n\n\n## 📡 API Reference\n\nThe FastAPI backend provides a RESTful API for accessing scripture data.\n\n### Try It Live\n- **API Docs**: [scriptures-fast-api.onrender.com/docs](https://scriptures-fast-api.onrender.com/docs) - Interactive Swagger UI\n- **Alternative Docs**: [scriptures-fast-api.onrender.com/redoc](https://scriptures-fast-api.onrender.com/redoc) - ReDoc interface\n\n### Quick API Example\n```bash\n# Get a random scripture\ncurl -s 'https://scriptures-fast-api.onrender.com/api/scriptures/random' | jq -r '\"\\(.verse_title)\\n\\(.scripture_text)\"'\n\n# Search for \"love\"\ncurl -s 'https://scriptures-fast-api.onrender.com/api/scriptures/search?q=love\u0026limit=3'\n```\n\nFor complete API documentation, see our **[API Standards Guide](./docs/api-standards.md)**.\n\n## 📚 Documentation\n\nOur documentation is organized to help you find exactly what you need:\n\n- **[📖 Getting Started](./docs/getting-started.md)** - New contributor onboarding\n- **[📚 Documentation Hub](./docs/README.md)** - All docs organized by role and task\n- **[🛠️ Development Workflow](./docs/development-workflow.md)** - How we develop and collaborate\n- **[📋 API Standards](./docs/api-standards.md)** - Comprehensive API design principles\n- **[🚀 Deployment Guide](./docs/deployment.md)** - How to deploy to production\n- **[📊 Monitoring](./docs/monitoring-setup.md)** - New Relic observability setup\n\n---\n\n## License\n\nThis project is open source and available under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillwillis%2Ffast-api-scripture-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillwillis%2Ffast-api-scripture-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillwillis%2Ffast-api-scripture-app/lists"}