{"id":31692518,"url":"https://github.com/yevhenbk/github-user-search","last_synced_at":"2026-04-10T02:53:32.261Z","repository":{"id":317041680,"uuid":"1065768368","full_name":"Yevhenbk/github-user-search","owner":"Yevhenbk","description":"This project demonstrates proficiency in Git-based workflows, CI/CD implementation, and modern web development practices.","archived":false,"fork":false,"pushed_at":"2025-09-28T13:27:48.000Z","size":102,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-28T13:29:22.101Z","etag":null,"topics":["cicd","eslint","github-actions","github-api","react","testing-library","typescript","vite","vitest"],"latest_commit_sha":null,"homepage":"https://yevhenbk.github.io/github-user-search/","language":"CSS","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/Yevhenbk.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-28T11:47:37.000Z","updated_at":"2025-09-28T13:29:09.000Z","dependencies_parsed_at":"2025-09-28T13:29:27.608Z","dependency_job_id":null,"html_url":"https://github.com/Yevhenbk/github-user-search","commit_stats":null,"previous_names":["yevhenbk/github-user-search"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/Yevhenbk/github-user-search","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yevhenbk%2Fgithub-user-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yevhenbk%2Fgithub-user-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yevhenbk%2Fgithub-user-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yevhenbk%2Fgithub-user-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yevhenbk","download_url":"https://codeload.github.com/Yevhenbk/github-user-search/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yevhenbk%2Fgithub-user-search/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278963832,"owners_count":26076542,"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","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"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","eslint","github-actions","github-api","react","testing-library","typescript","vite","vitest"],"created_at":"2025-10-08T14:53:36.041Z","updated_at":"2025-10-08T14:53:47.273Z","avatar_url":"https://github.com/Yevhenbk.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub User Search\n\nA modern React TypeScript application for searching GitHub users and repositories. This project demonstrates proficiency in **Git-based workflows**, **CI/CD implementation**, and **modern web development practices**.\n\n## 🎯 Project Purpose\n\nThis application serves multiple purposes:\n- **Portfolio demonstration** of full-stack development skills\n- **Git workflow mastery** showcase (GitFlow, branching strategies, PR workflows)\n- **CI/CD pipeline implementation** with automated testing and deployment\n- **Modern React ecosystem** proficiency with TypeScript, Vite, and testing\n\n## 🎨 Preview\n\n![GitHub User Search Preview](./docs/images/project_preview.png)\n\n## 🚀 Features\n\n- **Real-time GitHub user search** with debounced input\n- **User profile display** with avatar, bio, and statistics\n- **Repository listing** with sorting and filtering\n- **Responsive design** optimized for all devices\n- **Error handling** with user-friendly messages\n- **Loading states** and smooth transitions\n\n## 🛠 Technology Stack\n\n### Frontend\n- **React 19** with TypeScript\n- **Vite** for fast development and building\n- **CSS Modules** for component-scoped styling\n- **GitHub REST API** integration\n\n### Development Tools\n- **ESLint + Prettier** for code quality\n- **Vitest** for unit testing\n- **@testing-library/react** for component testing\n- **jsdom** for DOM simulation in tests\n\n### DevOps \u0026 Workflow\n- **Git Flow** branching strategy (`master` → `develop` → `feature/*`)\n- **GitHub Actions** for CI/CD pipeline\n- **Automated testing** on pull requests\n- **Environment-based deployments**\n\n## 📋 Prerequisites\n\n- Node.js 18+ and npm\n- Git for version control\n- GitHub account for API access\n\n## ⚙️ Installation \u0026 Setup\n\n1. **Clone the repository**\n   ```bash\n   git clone https://github.com/Yevhenbk/github-user-search.git\n   cd github-user-search\n   ```\n\n2. **Install dependencies**\n   ```bash\n   npm install\n   ```\n\n3. **Environment configuration**\n   ```bash\n   # Copy and configure environment variables\n   cp .env.example .env\n   ```\n   \n   Add your GitHub Personal Access Token to `.env`:\n   ```env\n   VITE_GITHUB_API_BASE_URL=https://api.github.com\n   VITE_GITHUB_TOKEN=your_github_token_here\n   ```\n\n4. **Start development server**\n   ```bash\n   npm run dev\n   ```\n\n## 🧪 Testing\n\nComprehensive test suite with multiple testing strategies:\n\n```bash\n# Run tests in watch mode\nnpm run test\n\n# Run tests once\nnpm run test:run\n\n# Run tests with UI (if @vitest/ui installed)\nnpm run test:ui\n```\n\n**Testing Coverage:**\n- Component rendering tests\n- User interaction simulation\n- API integration tests\n- Error boundary testing\n\n## 🔄 Git Workflow \u0026 CI/CD\n\n### Branching Strategy\nThis project implements **GitFlow methodology**:\n\n```\nmaster (production)\n└── develop (integration)\n    ├── feature/search-functionality\n    ├── feature/user-profile-display\n    └── feature/repository-listing\n```\n\n### Development Workflow\n1. **Feature Development**: `git checkout -b feature/feature-name develop`\n2. **Development**: Code, test, commit with conventional commits\n3. **Integration**: Create PR from `feature/*` → `develop`\n4. **Testing**: Automated CI pipeline runs tests\n5. **Release**: Merge `develop` → `master` for production\n\n### CI/CD Pipeline Features\n- **Automated Testing** on every PR\n- **Code Quality Checks** (ESLint, TypeScript)\n- **Build Verification** for production readiness\n- **Environment Deployments** (staging/production)\n- **Dependency Security Scanning**\n\n## 📚 API Integration\n\n### GitHub REST API\n- **Search Users**: `/search/users`\n- **User Details**: `/users/{username}`\n- **User Repositories**: `/users/{username}/repos`\n\n### Rate Limiting\n- **Unauthenticated**: 60 requests/hour\n- **Authenticated**: 5,000 requests/hour (with token)\n\n## 🏗 Project Structure\n\n```\nsrc/\n├── components/           # Reusable UI components\n├── pages/               # Route-level components\n├── api/                 # GitHub API integration\n├── hooks/               # Custom React hooks\n├── utils/               # Helper functions\n├── types/               # TypeScript definitions\n├── __tests__/           # Test files\n└── assets/              # Static resources\n```\n\n## 🔧 Available Scripts\n\n| Command | Description |\n|---------|-------------|\n| `npm run dev` | Start development server |\n| `npm run build` | Build for production |\n| `npm run preview` | Preview production build |\n| `npm run test` | Run tests in watch mode |\n| `npm run test:run` | Run tests once |\n| `npm run lint` | Lint code with ESLint |\n\n## 🎨 Code Quality \u0026 Standards\n\n- **TypeScript** for type safety\n- **ESLint + Prettier** for consistent formatting\n- **Conventional Commits** for clear commit history\n- **Component-driven development** with reusable components\n- **Test-driven development** with comprehensive coverage\n\n## 🔐 Environment Variables\n\n| Variable | Description | Required |\n|----------|-------------|----------|\n| `VITE_GITHUB_API_BASE_URL` | GitHub API base URL | Yes |\n| `VITE_GITHUB_TOKEN` | GitHub Personal Access Token | Optional* |\n\n*Token is optional but recommended for higher rate limits\n\n## 📈 Performance Optimizations\n\n- **Code splitting** with React.lazy()\n- **Debounced search** to reduce API calls\n- **Memoized components** for optimal re-renders\n- **Vite's fast HMR** for development efficiency\n\n## 🚀 Deployment\n\nThe application supports multiple deployment strategies:\n- **GitHub Pages** (static hosting)\n- **Netlify/Vercel** (JAMstack platforms)\n- **Docker containers** for containerized deployment\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create feature branch: `git checkout -b feature/amazing-feature develop`\n3. Commit changes: `git commit -m 'feat: add amazing feature'`\n4. Push to branch: `git push origin feature/amazing-feature`\n5. Open Pull Request to `develop` branch\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 👨‍💻 Author\n\n**Yevhen** - [GitHub Profile](https://github.com/Yevhenbk)\n\n---\n\n*This project demonstrates proficiency in modern web development, Git workflows, CI/CD practices, and test-driven development methodologies.*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyevhenbk%2Fgithub-user-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyevhenbk%2Fgithub-user-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyevhenbk%2Fgithub-user-search/lists"}