Skip to content

Latest commit

 

History

History
80 lines (70 loc) · 3.02 KB

README.md

File metadata and controls

80 lines (70 loc) · 3.02 KB
Raw

checker-api

Structure

.
├── README.md                   # Project documentation
├── package-lock.json           # Dependency lock file
├── package.json                # Project metadata and dependencies
├── src                         # Source code for the application
│   ├── controller              # Routing controller logic
│   ├── entity                  # TypeORM entities, defining database schemas and relations
│   ├── ext                     # External API integrations
│   ├── migration               # Database migrations for schema changes
│   ├── routes                  # API routes
│   ├── service                 # Business logic and service functions
│   ├── data-source.ts          # Database connection setup and configuration
│   ├── index.ts                # Application entry point
│   ├── postgraphile.config.ts  # Postgraphile configuration
│   ├── repository.ts           # Repositories for data access logic
│   ├── swagger.ts              # Optional: Swagger setup in TypeScript
│   └── utils.ts                # Utility functions and helper methods
└── tsconfig.json               # TypeScript configuration

Getting Started

  1. Basic Setup: 
    npm install
npm run prepare
  2. Configure Environment Variables: Create a .env file in the root of the project and set the necessary environment variables for database connection.
  3. Setting up your databas:
  • Connect as admin psql -U your_admin_username -h your_database_host -p your_database_port
  • In psql shell, run 
    CREATE DATABASE your_database_name;
CREATE ROLE your_database_username WITH LOGIN PASSWORD 'your_database_password';
GRANT ALL PRIVILEGES ON DATABASE your_database_name TO your_database_username;
  1. Handling Migration
  • Make changes to the entity
  • Generate migration with npm run generate --name=MigrationName
  • Run migration with npm run migrate
  • If you need to revert last migration, npm run revert
  1. Run the Development Server: 
    npm run dev
  2. API Overview
  • Visit http://localhost:3000/api-docs

Note

  • For Logging.md to understand use winston for logging
  • For Try catch handling done via catchError
  • All routes are documented using swagger
  • Postgraphile endpoint is hosted at http://localhost:3000/graphiql
Evaluations
------

router.post('/evaluations/manual-evaluation', createManualEvaluation)
router.post('/evaluations/llm-evaluation', triggerLLMEvaluation)

router.post('/pools', syncPool);
   - pool creation
   - application creation
      - for each application AI evaluation
   - question creation
   - profile creation 

# Nice to have
router.post('/evaluation-questions', createEvaluationQuestions);
router.post('/pools/:poolId/applications/auto', autoCreateApplication);
POST: /pools/:chainId/pools/:poolId/applications/:applicationId/review