{"id":31625015,"url":"https://github.com/vahiiiid/go-rest-api-docs","last_synced_at":"2026-05-08T07:34:40.554Z","repository":{"id":318082465,"uuid":"1069897598","full_name":"vahiiiid/go-rest-api-docs","owner":"vahiiiid","description":"Comprehensive documentation for the Go REST API Boilerplate (GRAB) — setup guides, architecture overview, API references, and deployment instructions, development guideline and examples..","archived":false,"fork":false,"pushed_at":"2026-04-11T21:35:22.000Z","size":4629,"stargazers_count":12,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-11T22:17:43.651Z","etag":null,"topics":["documentation","go","golang","hacktoberfest","mkdocs","open-api","rest","rest-api","swagger"],"latest_commit_sha":null,"homepage":"https://vahiiiid.github.io/go-rest-api-docs/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vahiiiid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/SECURITY_GUIDE.md","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-10-04T20:54:12.000Z","updated_at":"2026-04-11T21:34:59.000Z","dependencies_parsed_at":"2025-10-05T01:08:21.800Z","dependency_job_id":"48c65c9a-2c5e-46d7-b232-44f50d128f72","html_url":"https://github.com/vahiiiid/go-rest-api-docs","commit_stats":null,"previous_names":["vahiiiid/go-rest-api-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vahiiiid/go-rest-api-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahiiiid%2Fgo-rest-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahiiiid%2Fgo-rest-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahiiiid%2Fgo-rest-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahiiiid%2Fgo-rest-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vahiiiid","download_url":"https://codeload.github.com/vahiiiid/go-rest-api-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahiiiid%2Fgo-rest-api-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32771106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T02:36:36.067Z","status":"ssl_error","status_checked_at":"2026-05-08T02:36:07.210Z","response_time":54,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","go","golang","hacktoberfest","mkdocs","open-api","rest","rest-api","swagger"],"created_at":"2025-10-06T18:55:22.483Z","updated_at":"2026-05-08T07:34:40.513Z","avatar_url":"https://github.com/vahiiiid.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📚 Go REST API Boilerplate - Documentation\n\nOfficial documentation repository for the [Go REST API Boilerplate (GRAB)](https://github.com/vahiiiid/go-rest-api-boilerplate) project.\n\n[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://grabapi.dev/docs/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n## 🌐 View Documentation\n\n**🔗 Official Website:** https://grabapi.dev/\n\n**📚 Documentation:** https://grabapi.dev/docs/\n\nComplete, searchable documentation with dark mode, mobile-friendly navigation, and instant search.\n\n**Current Version**: v2.0.0 - Matches [GRAB v2.0.0](https://github.com/vahiiiid/go-rest-api-boilerplate/releases/tag/v2.0.0)\n\n## 📖 Contents\n\nThis documentation covers:\n\n- **🚀 Getting Started** - Setup guides and quick reference\n- **💻 Development** - Building features with complete TODO example\n- **🏗️ Architecture** - Project structure and design patterns\n- **🐳 Docker** - Container deployment and hot-reload setup\n- **📚 API Reference** - Swagger documentation guide\n- **🗄️ Database** - Migration management\n\n## 🛠️ Local Development\n\n### Prerequisites\n\n- Python 3.x\n- pip\n\n### Quick Start\n\n#### Automated Setup (Easiest)\n\n```bash\n# Run the setup script\n./setup-local.sh\n\n# This will:\n# - Create a virtual environment\n# - Install all dependencies\n# - Provide next steps\n\n# IMPORTANT: Activate the virtual environment first!\nsource venv/bin/activate\n\n# Then start the server\nmkdocs serve\n\n# Your prompt will show (venv) when activated\n```\n\n#### Option 1: Using Virtual Environment (Recommended for macOS)\n\n```bash\n# Create virtual environment\npython3 -m venv venv\n\n# Activate virtual environment\nsource venv/bin/activate\n\n# Install dependencies\npip install -r requirements.txt\n\n# Serve locally with hot-reload\nmkdocs serve\n\n# Visit http://127.0.0.1:8000\n\n# When done, deactivate\ndeactivate\n```\n\n#### Option 2: Using pipx (Alternative for macOS)\n\n```bash\n# Install pipx (if not already installed)\nbrew install pipx\n\n# Install mkdocs with pipx\npipx install mkdocs\npipx inject mkdocs mkdocs-material\npipx inject mkdocs mkdocs-minify-plugin\n\n# Serve locally\nmkdocs serve\n```\n\n#### Option 3: System-wide (Linux/Windows)\n\n```bash\n# Install dependencies\npip install -r requirements.txt\n\n# Serve locally with hot-reload\nmkdocs serve\n\n# Visit http://127.0.0.1:8000\n```\n\n### Building\n\n```bash\n# Build static site\nmkdocs build\n\n# Build with strict mode (recommended before committing)\nmkdocs build --strict\n```\n\n\u003e **Note for macOS users:** macOS uses externally-managed Python environments. We recommend using a virtual environment (Option 1) or pipx (Option 2) to avoid conflicts with system Python packages.\n\n## 📁 Repository Structure\n\n```\ngo-rest-api-docs/\n├── mkdocs.yml              # MkDocs configuration\n├── requirements.txt        # Python dependencies\n├── setup-local.sh          # Automated setup script\n├── docs/                   # Documentation content\n│   ├── README.md          # Documentation home\n│   ├── SETUP.md           # Setup guide\n│   ├── DEVELOPMENT_GUIDE.md  # Development guide with TODO example\n│   ├── DOCKER.md          # Docker guide\n│   ├── SWAGGER.md         # API documentation guide\n│   ├── QUICK_REFERENCE.md # Quick reference\n│   ├── PROJECT_SUMMARY.md # Architecture overview\n│   ├── DOCS_SETUP.md      # Documentation setup guide\n│   └── images/            # Screenshots and diagrams\n├── assets/                 # Logo and assets\n│   └── logo.png\n├── .github/\n│   └── workflows/\n│       └── docs.yml       # Deployment workflow\n└── README.md              # This file\n```\n\n## 🤝 Contributing\n\nContributions to the documentation are welcome! Please:\n\n1. **Fork** this repository\n2. **Create a branch** for your changes\n3. **Make your edits** to the `.md` files in `docs/`\n4. **Test locally** with `mkdocs serve`\n5. **Submit a pull request**\n\n### Documentation Guidelines\n\n- **Use clear, concise language** - Write for developers of all levels\n- **Include code examples** - Show, don't just tell\n- **Test all commands** - Ensure examples work\n- **Add screenshots** - Visual aids help understanding\n- **Update navigation** - Add new pages to `mkdocs.yml`\n- **Check links** - Verify all internal and external links work\n\n### Style Guide\n\n- Use H2 (`##`) for major sections\n- Use H3 (`###`) for subsections\n- Use code blocks with language tags for syntax highlighting\n- Use admonitions for tips, warnings, and notes:\n\n```markdown\n!!! tip \"Pro Tip\"\n    This is a helpful tip!\n\n!!! warning\n    This is important to know!\n```\n\n## 🚀 Deployment\n\nDocumentation is served at `https://grabapi.dev/docs/` via the landing site's Cloudflare Pages build.\n\n### Deployment Workflow\n\n1. Push changes to `main` in this docs repository\n2. Trigger a new deploy for `grabapi-landing` in Cloudflare Pages (or via deploy hook)\n3. Build script pulls latest docs and publishes to `/docs`\n\nDeployment typically takes 2-3 minutes.\n\n## 🔗 Links\n\n- **Main Repository:** https://github.com/vahiiiid/go-rest-api-boilerplate\n- **Official Website:** https://grabapi.dev/\n- **Documentation Site:** https://grabapi.dev/docs/\n- **Report Issues:** https://github.com/vahiiiid/go-rest-api-docs/issues\n- **Code Issues:** https://github.com/vahiiiid/go-rest-api-boilerplate/issues\n\n## 📋 Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for documentation changes.\n\nFor API/code changes, see the [main repository changelog](https://github.com/vahiiiid/go-rest-api-boilerplate/blob/main/CHANGELOG.md).\n\n## 📄 License\n\nMIT License - same as the main project.\n\nCopyright (c) 2025 vahiiiid\n\n---\n\n**Built with [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvahiiiid%2Fgo-rest-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvahiiiid%2Fgo-rest-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvahiiiid%2Fgo-rest-api-docs/lists"}