{"id":30351659,"url":"https://github.com/rubenoalvarado/game-database-api","last_synced_at":"2025-09-01T01:32:32.993Z","repository":{"id":300661708,"uuid":"1006680510","full_name":"RubenOAlvarado/game-database-api","owner":"RubenOAlvarado","description":"NestJs API for the Game Database Project. ","archived":false,"fork":false,"pushed_at":"2025-06-24T22:24:04.000Z","size":106,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-18T23:20:43.873Z","etag":null,"topics":["api-rest","nestjs","nodejs","rawg-api","rest-api","typescript"],"latest_commit_sha":null,"homepage":"https://game-database-api-b4bz.onrender.com","language":"TypeScript","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/RubenOAlvarado.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-22T19:29:31.000Z","updated_at":"2025-06-25T15:33:16.000Z","dependencies_parsed_at":"2025-06-23T00:32:57.049Z","dependency_job_id":"d863a73f-d614-482f-bf4e-fa1812e76b8d","html_url":"https://github.com/RubenOAlvarado/game-database-api","commit_stats":null,"previous_names":["rubenoalvarado/game-database-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RubenOAlvarado/game-database-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubenOAlvarado%2Fgame-database-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubenOAlvarado%2Fgame-database-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubenOAlvarado%2Fgame-database-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubenOAlvarado%2Fgame-database-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RubenOAlvarado","download_url":"https://codeload.github.com/RubenOAlvarado/game-database-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RubenOAlvarado%2Fgame-database-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273064337,"owners_count":25039259,"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-08-31T02:00:09.071Z","response_time":79,"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":["api-rest","nestjs","nodejs","rawg-api","rest-api","typescript"],"created_at":"2025-08-18T23:11:39.106Z","updated_at":"2025-09-01T01:32:32.969Z","avatar_url":"https://github.com/RubenOAlvarado.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Game Database API\n\nA RESTful API built with NestJS that provides access to game information and details. This API serves as a backend service for game-related applications, offering endpoints to search for games and retrieve detailed information about specific games.\n\n## Features\n\n- 🎮 Search games by query\n- 📊 Get detailed game information by slug\n- 🚦 Rate limiting with throttling\n- 🌐 CORS support for cross-origin requests\n- 🔧 Environment-based configuration\n- 📝 TypeScript support\n- ✅ Comprehensive testing setup\n\n## Tech Stack\n\n- **Framework**: NestJS\n- **Language**: TypeScript\n- **HTTP Client**: Axios\n- **Configuration**: @nestjs/config\n- **Rate Limiting**: @nestjs/throttler\n- **Testing**: Jest, Supertest\n- **Code Quality**: ESLint, Prettier\n\n## Prerequisites\n\n- Node.js (v18 or higher)\n- npm or yarn\n- An API key for the game database service\n\n## Installation\n\n1. Clone the repository:\n```bash\ngit clone \u003crepository-url\u003e\ncd game-database-api\n```\n\n2. Install dependencies:\n```bash\nnpm install\n```\n\n3. Create a `.env` file in the root directory:\n```env\nBASE_URL=your_game_api_base_url\nAPI_KEY=your_api_key\nCLIENT_DOMAIN=http://localhost:3001\nPORT=3000\n```\n\n## Running the Application\n\n```bash\n# Development mode\nnpm run start:dev\n\n# Production mode\nnpm run start:prod\n\n# Debug mode\nnpm run start:debug\n```\n\nThe API will be available at `http://localhost:3000/api`\n\n## API Endpoints\n\n### Games\n\n#### Get Games\n```http\nGET /api/games?search={query}\n```\n\n**Parameters:**\n- `search` (string): Search query for games\n\n**Response:**\n```json\n[\n  {\n    \"id\": 1,\n    \"name\": \"Game Name\",\n    \"slug\": \"game-slug\",\n    // ... other game properties\n  }\n]\n```\n\n#### Get Game Details\n```http\nGET /api/games/{slug}\n```\n\n**Parameters:**\n- `slug` (string): Game slug identifier\n\n**Response:**\n```json\n{\n  \"id\": 1,\n  \"name\": \"Game Name\",\n  \"description\": \"Game description\",\n  // ... detailed game properties\n}\n```\n\n## Rate Limiting\n\nThe API implements rate limiting with the following configuration:\n- **Limit**: 10 requests per minute per IP\n- **Time Window**: 60 seconds\n\n## Development\n\n### Code Formatting\n```bash\nnpm run format\n```\n\n### Linting\n```bash\nnpm run lint\n```\n\n### Testing\n```bash\n# Unit tests\nnpm run test\n\n# E2E tests\nnpm run test:e2e\n\n# Test coverage\nnpm run test:cov\n\n# Watch mode\nnpm run test:watch\n```\n\n### Building\n```bash\nnpm run build\n```\n\n## Project Structure\n\n```\nsrc/\n├── app.controller.ts     # Main controller with game endpoints\n├── app.service.ts        # Business logic for game operations\n├── app.module.ts         # Root module configuration\n└── main.ts              # Application entry point\n\ntest/\n└── app.e2e-spec.ts      # End-to-end tests\n```\n\n## Environment Variables\n\n| Variable | Description | Required |\n|----------|-------------|----------|\n| `BASE_URL` | Base URL for the external game API | Yes |\n| `API_KEY` | API key for authentication | Yes |\n| `CLIENT_DOMAIN` | Allowed origin for CORS | No |\n| `PORT` | Server port (default: 3000) | No |\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Author\n- [Ruben O. Alvarado](https://github.com/RubenOAlvarado)\n- [LinkedIn](https://www.linkedin.com/in/ruben-alvarado-molina-9020010/)\n- [X (twitter)](https://twitter.com/RubenOAlvarado)\n- [Instagram](https://www.instagram.com/alvaradorubo/)\n\n*Built with ❤️ using NestJS*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubenoalvarado%2Fgame-database-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubenoalvarado%2Fgame-database-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubenoalvarado%2Fgame-database-api/lists"}