Loading repository data…
b3nito404 / repository
A complete, production-ready REST API in TypeScript with Express, tested, Dockerized, and integrated into a CI/CD pipeline with Jenkins.
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
admin / user)# Install
npm ci
# Configure
cp .env.example .env
# Start MongoDB (if not running)
docker run -d -p 27017:27017 --name mongo mongo:7.0-jammy
# Seed (optional)
npx ts-node scripts/seed.ts
# Dev server (hot reload)
npm run dev
API -> http://localhost:3000/api/v1
# Full stack (API + MongoDB)
docker-compose up -d
# With Mongo Express UI (port 8081)
docker-compose --profile tools up -d
# Logs
docker-compose logs -f api
# Stop
docker-compose down
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d
# Or manually
docker build -t express-api:latest .
docker run -p 3000:3000 --env-file .env express-api:latest
| Variable | Default | Description |
|---|---|---|
NODE_ENV | development | Environment |
PORT | 3000 | Server port |
API_VERSION | v1 | API version prefix |
MONGODB_URI | mongodb://localhost:27017/api_db | MongoDB connection string |
JWT_SECRET | — | Required in production |
JWT_EXPIRES_IN | 7d | Token expiry |
RATE_LIMIT_WINDOW_MS | 900000 | Rate limit window (15 min) |
RATE_LIMIT_MAX | 100 | Max requests per window |
LOG_LEVEL | info | Winston log level |
Base URL: http://localhost:3000/api/v1
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| GET | /health | None | Full status (DB, memory, system) |
| GET | /health/live | None | Liveness probe |
| GET | /health/ready | None | Readiness probe |
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| POST | /users/register | None | Register |
| POST | /users/login | None | Login -> JWT |
| GET | /users/me | Bearer | Own profile |
| PATCH | /users/me/password | Bearer | Change password |
| GET | /users | Admin | List all (paginated) |
| GET | /users/:id | Admin | Get by ID |
| PATCH | /users/:id | Bearer | Update |
| DELETE | /users/:id | Admin | Delete |
# Register
curl -X POST http://localhost:3000/api/v1/users/register \
-H "Content-Type: application/json" \
-d '{"name":"Alice","email":"alice@example.com","password":"Password1"}'
# Login
curl -X POST http://localhost:3000/api/v1/users/login \
-H "Content-Type: application/json" \
-d '{"email":"alice@example.com","password":"Password1"}'
# Profile
curl http://localhost:3000/api/v1/users/me \
-H "Authorization: Bearer <token>"
# List users (admin)
curl "http://localhost:3000/api/v1/users?page=1&limit=10&search=alice" \
-H "Authorization: Bearer <admin_token>"
{
"success": true,
"message": "Users retrieved",
"data": [],
"meta": { "page": 1, "limit": 10, "total": 42, "totalPages": 5 }
}
{
"success": false,
"message": "Validation failed",
"errors": [{ "field": "email", "msg": "Valid email required" }]
}
npm test # All tests + coverage
npm run test:watch # Watch mode
npx jest tests/user.test.ts # Single file
Coverage enforced in CI: 80% lines / 75% functions
| File | Description |
|---|---|
tests/setup.ts | MongoDB test connection + collection cleanup |
tests/helpers.ts | createUser(), loginUser(), authHeader() |
tests/health.test.ts | Health endpoint smoke tests |
tests/user.test.ts | Full auth, CRUD, RBAC 25+ cases |
10-stage declarative pipeline defined in Jenkinsfile:
| Stage | Description |
|---|---|
| Checkout | Clone + compute image tag (buildNum-gitSHA) |
| Install | npm ci with dependency cache |
| Lint | ESLint fails fast |
| Build | TypeScript compilation |
| Test | Jest + ephemeral MongoDB + coverage report |
| Security Audit | npm audit --audit-level=high |
| Docker Build | Multi-stage production image |
| Docker Push | Push to registry (main + develop only) |
| Deploy Staging | Auto-deploy on develop |
| Deploy Production | Manual approval gate -> main |
| ID | Type | Description |
|---|---|---|
docker-registry-url | Secret text | Registry hostname |
docker-registry-credentials | Username/password | Registry login |
deploy-ssh-key | SSH key | Deploy server access |
src/ ├── config/ # Env, DB connection ├── middleware/ # Auth, error handler, rate limit ├── modules/ │ └── users/ │ ├── user.model.ts │ ├── user.repository.ts │ ├── user.service.ts │ ├── user.controller.ts │ └── user.routes.ts ├── utils/ # AppError, logger, response helpers └── app.ts
Error handling: AppError carries HTTP status. Global errorHandler catches all errors including Mongoose/MongoDB driver errors.
npx ts-node scripts/seed.ts
| Password | Role | |
|---|---|---|
| admin@example.com | Admin@1234 | admin |
| user@example.com | User@1234 | user |
Selected from shared topics, language and repository description—not editorial ratings.
kahveciderin /
Your Drizzle schema is already a backend. Covara turns it into a complete, production-ready API — REST endpoints, real-time subscriptions, auth, file uploads, billing, email, and background jobs — with a type-safe, offline-first TypeScript client on the other end.
65/100 health