{"id":29177855,"url":"https://github.com/gitcoinco/checker-api","last_synced_at":"2025-07-01T18:08:55.397Z","repository":{"id":261434442,"uuid":"881889810","full_name":"gitcoinco/checker-api","owner":"gitcoinco","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-16T15:18:42.000Z","size":822,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-16T21:26:14.251Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://api.checker.gitcoin.co/","language":"TypeScript","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/gitcoinco.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}},"created_at":"2024-11-01T12:55:08.000Z","updated_at":"2025-04-16T15:18:46.000Z","dependencies_parsed_at":"2025-01-28T14:31:42.666Z","dependency_job_id":"99f6c195-779b-4c9b-93ca-11f3e50388ba","html_url":"https://github.com/gitcoinco/checker-api","commit_stats":null,"previous_names":["gitcoinco/checker-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gitcoinco/checker-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fchecker-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fchecker-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fchecker-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fchecker-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitcoinco","download_url":"https://codeload.github.com/gitcoinco/checker-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fchecker-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263013738,"owners_count":23399815,"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-07-01T18:08:54.358Z","updated_at":"2025-07-01T18:08:55.366Z","avatar_url":"https://github.com/gitcoinco.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# checker-api\n\n## Structure\n\n```\n.\n├── README.md                   # Project documentation\n├── package-lock.json           # Dependency lock file\n├── package.json                # Project metadata and dependencies\n├── src                         # Source code for the application\n│   ├── controller              # Routing controller logic\n│   ├── entity                  # TypeORM entities, defining database schemas and relations\n│   ├── ext                     # External API integrations\n│   ├── migration               # Database migrations for schema changes\n│   ├── routes                  # API routes\n│   ├── service                 # Business logic and service functions\n│   ├── data-source.ts          # Database connection setup and configuration\n│   ├── index.ts                # Application entry point\n│   ├── postgraphile.config.ts  # Postgraphile configuration\n│   ├── repository.ts           # Repositories for data access logic\n│   ├── swagger.ts              # Optional: Swagger setup in TypeScript\n│   └── utils.ts                # Utility functions and helper methods\n└── tsconfig.json               # TypeScript configuration\n```\n\n## Getting Started\n\n1. **Basic Setup**:\n   ```bash\n   npm install\n   npm run prepare\n   ```\n2. **Configure Environment Variables**:\n   Create a `.env` file in the root of the project and set the necessary environment variables for database connection.\n3. **Setting up your databas**:\n- Connect as admin `psql -U your_admin_username -h your_database_host -p your_database_port`\n- In `psql` shell, run\n  ```shell\n  CREATE DATABASE your_database_name;\n  CREATE ROLE your_database_username WITH LOGIN PASSWORD 'your_database_password';\n  GRANT ALL PRIVILEGES ON DATABASE your_database_name TO your_database_username;\n  ```\n4. **Handling Migration**\n- Make changes to the entity\n- Generate migration with `npm run generate --name=MigrationName`\n- Run migration with `npm run migrate`\n- If you need to revert last migration, `npm run revert`\n5. **Run the Development Server**:\n   ```bash\n   npm run dev\n   ```\n6. **API Overview**\n  - Visit `http://localhost:3000/api-docs`\n\n**Note**\n\n- For [Logging.md](./src//logger/logger.md) to understand use winston for logging\n- For Try catch handling done via [catchError](./src/utils.ts)\n- All routes are documented using [swagger](./src/swagger.ts)\n- Postgraphile endpoint is hosted at `http://localhost:3000/graphiql`\n\n```\nEvaluations\n------\n\nrouter.post('/evaluations/manual-evaluation', createManualEvaluation)\nrouter.post('/evaluations/llm-evaluation', triggerLLMEvaluation)\n\nrouter.post('/pools', syncPool);\n   - pool creation\n   - application creation\n      - for each application AI evaluation\n   - question creation\n   - profile creation \n\n# Nice to have\nrouter.post('/evaluation-questions', createEvaluationQuestions);\nrouter.post('/pools/:poolId/applications/auto', autoCreateApplication);\nPOST: /pools/:chainId/pools/:poolId/applications/:applicationId/review\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitcoinco%2Fchecker-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitcoinco%2Fchecker-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitcoinco%2Fchecker-api/lists"}