Skip to content

badging/BadgingAPI

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

194 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

DEI Badging API

Server-side application for the CHAOSS DEI Badging program, supporting both Project Badging (automated DEI.md scanning) and Event Badging (review-driven process via GitHub webhooks).

Technology Stack

  • TypeScript - Type-safe JavaScript
  • TypeDI - Dependency injection
  • routing-controllers - Decorator-based HTTP routing
  • sequelize-typescript - TypeScript ORM
  • Express - HTTP server

Quick Start

cd src
npm install
npm run configure  # Interactive setup for .env
npm run dev        # Development server with hot reload

Project Structure

src/
β”œβ”€β”€ shared/           # Shared code (types, services, providers, data-access)
β”œβ”€β”€ auth/             # Authentication module (GitHub/GitLab OAuth)
β”œβ”€β”€ project-badging/  # Automated DEI badge scanning
β”œβ”€β”€ event-badging/    # Review-driven event badging via webhooks
β”œβ”€β”€ scripts/          # CLI tools (configure.ts)
β”œβ”€β”€ app.ts            # Express app configuration
└── index.ts          # Server entry point

API Endpoints

Endpoint Method Description
/api/callback/github GET GitHub OAuth callback
/api/callback/gitlab GET GitLab OAuth callback
/api/badgedRepos GET Get all badged repositories
/api/repos-to-badge POST Scan repos for DEI.md
/api/event_badging POST GitHub webhook for events
/api/badged_events GET Get all badged events

Documentation

License

See LICENSE file.

About

Server side development of the DEI Project Badging focusing on scripting, databases, back-end logic, & APIs

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages