{"id":26831371,"url":"https://github.com/benjaminbwright/fastapi-template","last_synced_at":"2025-03-30T14:32:17.004Z","repository":{"id":280514223,"uuid":"942253049","full_name":"benjaminbwright/fastAPI-template","owner":"benjaminbwright","description":"A template for quick starting a fastAPI project","archived":false,"fork":false,"pushed_at":"2025-03-03T20:51:41.000Z","size":8373,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-03T21:31:21.866Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/benjaminbwright.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2025-03-03T20:21:54.000Z","updated_at":"2025-03-03T20:51:45.000Z","dependencies_parsed_at":"2025-03-03T21:41:28.137Z","dependency_job_id":null,"html_url":"https://github.com/benjaminbwright/fastAPI-template","commit_stats":null,"previous_names":["benjaminbwright/fastapi-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benjaminbwright%2FfastAPI-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benjaminbwright%2FfastAPI-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benjaminbwright%2FfastAPI-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benjaminbwright%2FfastAPI-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benjaminbwright","download_url":"https://codeload.github.com/benjaminbwright/fastAPI-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246332374,"owners_count":20760468,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2025-03-30T14:32:16.494Z","updated_at":"2025-03-30T14:32:16.993Z","avatar_url":"https://github.com/benjaminbwright.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FastAPI Project Template\n\nA modern, production-ready template for building APIs with Python 3.8+ using FastAPI. This template provides a modular structure and includes a TODO list CRUD example to demonstrate best practices.\n\n## Features\n\n- 🚀 FastAPI for high-performance API development\n- 📁 Modular project structure\n- 🔍 Example TODO list CRUD implementation\n- 📝 Auto-generated API documentation (Swagger/OpenAPI)\n- ✨ Clean, maintainable architecture\n- 🔒 Type safety with Pydantic models\n\n## Quick Start\n\n### Prerequisites\n\n- Python 3.8 or higher\n- pip (Python package installer)\n\n### Setup\n\n1. Clone the template:\n\n   ```bash\n   git clone https://github.com/yourusername/fastapi-template.git\n   cd fastapi-template\n   ```\n\n2. Create and activate virtual environment:\n\n   ```bash\n   # Create virtual environment\n   python -m venv venv\n\n   # Windows\n   .\\venv\\Scripts\\activate\n\n   # macOS/Linux\n   source venv/bin/activate\n   ```\n\n3. Install dependencies:\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n4. Run the application:\n\n   ```bash\n   python main.py\n   ```\n\n5. Open http://localhost:8000/docs to view the API documentation\n\n## Project Structure\n\nfastapi-template/\n├── main.py # Application entry point\n├── requirements.txt # Project dependencies\n├── models/ # Data models\n│ └── todo.py # TODO models\n└── routes/ # API routes\n└── todo_routes.py # TODO endpoints\n\n## API Endpoints\n\nThe template includes a complete TODO list API:\n\n- `GET /todos` - List all todos\n- `POST /todos` - Create a todo\n- `GET /todos/{id}` - Get a specific todo\n- `PUT /todos/{id}` - Update a todo\n- `DELETE /todos/{id}` - Delete a todo\n\n## Contributing\n\nWe welcome contributions! Here's how to contribute to this project:\n\n### Making Changes\n\n1. Fork the repository\n2. Create a feature branch:\n   ```bash\n   git checkout -b feature/your-feature-name\n   ```\n3. Make your changes\n4. Test your changes\n5. Commit with clear messages:\n   ```bash\n   git commit -m \"feat: add new feature\"\n   ```\n\n### Submitting a Pull Request\n\n1. Push to your fork:\n   ```bash\n   git push origin feature/your-feature-name\n   ```\n2. Go to the original repository and create a Pull Request\n3. Fill in the PR template with:\n   - Description of changes\n   - Related issue(s)\n   - Testing performed\n   - Screenshots (if applicable)\n\n### Pull Request Guidelines\n\n- Follow existing code style\n- Add tests for new features\n- Update documentation\n- One feature per PR\n- Keep PRs focused and manageable in size\n\n## Development\n\n### Code Style\n\n- Follow PEP 8 guidelines\n- Use type hints\n- Write docstrings for functions and classes\n- Keep functions focused and single-purpose\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Getting Help\n\n- Check the [FastAPI documentation](https://fastapi.tiangolo.com/)\n- Open an issue for bugs\n- Start a discussion for questions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenjaminbwright%2Ffastapi-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenjaminbwright%2Ffastapi-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenjaminbwright%2Ffastapi-template/lists"}