{"id":13558165,"url":"https://github.com/toyoshi/wikigo","last_synced_at":"2025-09-30T13:30:59.640Z","repository":{"id":11273778,"uuid":"69030314","full_name":"toyoshi/wikigo","owner":"toyoshi","description":"Ruby on Rails 6.0 wiki","archived":false,"fork":false,"pushed_at":"2023-01-19T11:05:08.000Z","size":1482,"stargazers_count":3,"open_issues_count":39,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-14T11:20:51.965Z","etag":null,"topics":["rails","rails6","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/toyoshi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-23T14:04:45.000Z","updated_at":"2020-01-28T12:38:53.000Z","dependencies_parsed_at":"2023-02-10T23:01:04.596Z","dependency_job_id":null,"html_url":"https://github.com/toyoshi/wikigo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toyoshi%2Fwikigo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toyoshi%2Fwikigo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toyoshi%2Fwikigo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toyoshi%2Fwikigo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toyoshi","download_url":"https://codeload.github.com/toyoshi/wikigo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234737856,"owners_count":18879180,"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":["rails","rails6","ruby"],"created_at":"2024-08-01T12:04:47.322Z","updated_at":"2025-09-30T13:30:59.623Z","avatar_url":"https://github.com/toyoshi.png","language":"Ruby","funding_links":[],"categories":["Ruby","ruby"],"sub_categories":[],"readme":"# WikiGo\n\n\u003cimg src='https://cloud.githubusercontent.com/assets/188394/19829766/528c7046-9e25-11e6-9271-0fa6916b770b.png' width='500'\u003e\n\nA simple, modern wiki engine built with Ruby on Rails 8. WikiGo automatically creates links between pages when you mention a page title anywhere in your content.\n\n## Features\n\n\u003cimg src='https://cloud.githubusercontent.com/assets/188394/19829747/d9d0b680-9e24-11e6-9d1d-40e20604f170.png' width='500'\u003e\n\n- **Auto-linking**: Page titles automatically become links throughout the wiki\n- **Multi-user**: User authentication and role-based access\n- **Rich text editing**: ActionText editor with Trix for content creation\n- **Tagging system**: Organize content with tags\n- **Version history**: Track changes with PaperTrail\n- **Search functionality**: Find content across all pages\n- **REST API**: Full API access for integrations and automation\n- **Modern UI**: Bootstrap 5 responsive design\n- **Rails 8 native**: Uses Solid Cache, Solid Queue, and Solid Cable\n\n## Technology Stack\n\n- **Ruby on Rails 8.0** - Modern web framework\n- **Solid Trifecta** - Database-backed cache, queue, and cable (no Redis required)\n- **ActionText** - Rich text editing with Trix editor\n- **Bootstrap 5** - Responsive UI framework\n- **SQLite/PostgreSQL** - Database options for development/production\n- **Propshaft** - Rails 8 asset pipeline\n- **Importmaps** - ES6 modules without bundling\n\n## Quick Start\n\n### Development\n\n1. **Clone the repository**\n   ```bash\n   git clone https://github.com/toyoshi/wikigo.git\n   cd wikigo\n   ```\n\n2. **Using Docker (Recommended)**\n   ```bash\n   docker-compose up\n   ```\n   Visit http://localhost:3000\n\n3. **Local development**\n   ```bash\n   bundle install\n   rails db:create db:migrate db:seed\n   rails server\n   ```\n\n### Production Deployment\n\nWikiGo is designed to be simple to deploy with minimal infrastructure requirements.\n\n**Heroku Deployment**\n[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)\n\n**Docker Deployment**\n```bash\ndocker build -t wikigo .\ndocker run -p 3000:3000 wikigo\n```\n\n## Configuration\n\n### Environment Variables\n\n- `RAILS_ENV` - Set to `production` for production deployment\n- `SECRET_KEY_BASE` - Rails secret key (auto-generated)\n- `DATABASE_URL` - PostgreSQL connection string for production\n\n### Optional Features\n\n- **Image uploads**: Configure Active Storage for file attachments\n- **Email notifications**: Set up Action Mailer for user notifications\n- **Custom themes**: Modify Bootstrap variables in `app/assets/stylesheets/`\n\n## How It Works\n\nWikiGo's key feature is **automatic keyword linking**. When you create a page with a title like \"Ruby on Rails\", that exact phrase will automatically become a clickable link on any other page where it appears. This creates a natural, interconnected knowledge base without manual link management.\n\n## REST API\n\nWikiGo provides a comprehensive REST API for programmatic access to all wiki functionality. Perfect for integrations, automation, and building custom applications.\n\n### API Features\n\n- **Full CRUD operations** for wiki pages (Words)\n- **Search and filtering** capabilities\n- **Tag management** and filtering by tags\n- **Bearer token authentication** for secure access\n- **Pagination and sorting** for large datasets\n- **Comprehensive error handling** with detailed responses\n\n### Quick API Example\n\n```bash\n# Get all pages\ncurl -H \"Authorization: Bearer YOUR_API_TOKEN\" \\\n     https://your-wikigo-instance.com/api/v1/words\n\n# Search pages\ncurl -H \"Authorization: Bearer YOUR_API_TOKEN\" \\\n     \"https://your-wikigo-instance.com/api/v1/words/search?q=documentation\"\n\n# Create a new page\ncurl -X POST \\\n     -H \"Authorization: Bearer YOUR_API_TOKEN\" \\\n     -H \"Content-Type: application/json\" \\\n     -d '{\"word\":{\"title\":\"API Guide\",\"body\":\"Content here\",\"tag_list\":\"api,guide\"}}' \\\n     https://your-wikigo-instance.com/api/v1/words\n```\n\n### API Documentation\n\n📖 **[Complete REST API Documentation](./WikiGo-REST-API-Documentation.md)**\n\n- Authentication setup\n- All available endpoints\n- Request/response examples\n- Error handling\n- SDK examples in multiple languages\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Submit a pull request\n\n## License\n\nThis project is available under the MIT License.\n\n## Support\n\n- Create an issue for bug reports or feature requests\n- Check the wiki for documentation and examples\n- Review the codebase - it's designed to be readable and educational","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoyoshi%2Fwikigo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoyoshi%2Fwikigo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoyoshi%2Fwikigo/lists"}