{"id":34656025,"url":"https://github.com/nazmul-nhb/test-school-server","last_synced_at":"2026-05-28T19:02:54.876Z","repository":{"id":308866651,"uuid":"1034381025","full_name":"nazmul-nhb/test-school-server","owner":"nazmul-nhb","description":"Server for Test School","archived":false,"fork":false,"pushed_at":"2025-08-16T15:25:08.000Z","size":627,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-26T06:53:48.926Z","etag":null,"topics":["assesment","express","lms","mongoose","nhb-express","nhb-scripts","nhb-toolbox","school","server","test","typescript"],"latest_commit_sha":null,"homepage":"https://test-school-server.vercel.app","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/nazmul-nhb.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":"2025-08-08T09:47:59.000Z","updated_at":"2025-08-16T15:25:11.000Z","dependencies_parsed_at":"2025-08-08T11:38:31.884Z","dependency_job_id":"67eab196-b527-4744-8ce5-869e214d1c97","html_url":"https://github.com/nazmul-nhb/test-school-server","commit_stats":null,"previous_names":["nazmul-nhb/test-school-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nazmul-nhb/test-school-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nazmul-nhb%2Ftest-school-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nazmul-nhb%2Ftest-school-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nazmul-nhb%2Ftest-school-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nazmul-nhb%2Ftest-school-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nazmul-nhb","download_url":"https://codeload.github.com/nazmul-nhb/test-school-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nazmul-nhb%2Ftest-school-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33622070,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-28T02:00:06.440Z","response_time":99,"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":["assesment","express","lms","mongoose","nhb-express","nhb-scripts","nhb-toolbox","school","server","test","typescript"],"created_at":"2025-12-24T18:01:23.964Z","updated_at":"2026-05-28T19:02:54.856Z","avatar_url":"https://github.com/nazmul-nhb.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 Express TypeScript Mongoose Server\n\nBootstrapped with [**nhb-express**](https://www.npmjs.com/package/nhb-express)\n\n---\n\n## 📦 Features\n\n- ✅ **TypeScript** with `ts-node` and `nodemon` for development and pre-configured `tsconfig.json`\n- ✅ **Express.js** pre‑configured with custom middlewares\n- ✅ **Zod** for schema validation\n- ✅ **Mongoose** for MongoDB integration\n- ✅ **Chalk** for colorful logging\n- ✅ **[nhb-scripts](https://www.npmjs.com/package/nhb-scripts)** for easy build, commit, module scaffolding, formatting, linting, and more. [see below](#️-scripts)\n- ✅ **Scaffolding via CLI** – choose package manager, DB, etc.\n- ✅ Built‑in [**CI/CD workflow**](#️-cicd-workflow) for automatic deployment to Vercel\n- ✅ Pre‑set configs for ESLint, Prettier, and `nhb-scripts`\n\n---\n\n## 🚀 Development\n\nInstall dependencies (already done by `nhb-express` scaffold)\n\nRun in development mode:\n\n```bash\npnpm dev     # or npm run dev / yarn dev\n# Runs on port: 4242\n```\n\n---\n\n## 📁 Structure\n\n```text\n\u003cyour-project-name\u003e/\n ├─ .github/\n │   └─ workflows/\n │       └─ publish.yml     # GitHub Actions workflow for CI/CD (vercel deployment) \n ├─ .vscode/\n │   └─ settings.json       # VS Code Settings for better formatting\n ├─ src/\n │   |─ app/\n │   |   ├─ classes/        # Utility classes e.g. `QueryBuilder`, `ErrorWihStatus`\n │   |   ├─ configs/        # App configurations\n │   |   ├─ constants/      # Constant values\n │   |   ├─ errors/         # Custom error processors/handlers\n │   |   ├─ middlewares/    # Custom Express middlewares\n │   |   ├─ modules/        # Feature modules (controllers, services, etc.)\n │   |   ├─ routes/         # Route definitions\n │   |   ├─ types/          # Types for the App\n │   |   └─ utilities/      # Helper functions\n │   |\n │   ├─ app.ts              # Express app setup\n │   ├─ index.d.ts          # Global type declarations\n │   └─ server.ts           # Server bootstrap\n │\n ├─ .env                    # Environment variables\n ├─ .gitignore              # Ignore files/folders from being pushed/committed\n ├─ .prettierignore         # Ignore files/folders from being formatted with prettier\n ├─ .prettierrc.json        # Prettier config\n ├─ eslint.config.mjs       # ESLint config (flat config, ready for TS)\n ├─ nhb.scripts.config.mjs  # Config for nhb-scripts\n ├─ nodemon.json            # Nodemon settings\n ├─ package.json\n ├─ README.md\n ├─ secret.mjs              # Generate secrets for jwt (using crypto module, just run in cli: node secret.mjs or pnpm/npm/yarn run secret)\n ├─ tsconfig.json           # Ready to use tsconfig\n └─ vercel.json             # Deployment config for Vercel\n```\n\n---\n\n## 🛠️ Scripts\n\n- `pnpm dev` – Start in dev mode with hot reload\n- `pnpm start` – Run the built server\n- `pnpm deploy` – Build the project and deploy to Vercel (`nhb-build \u0026\u0026 vercel --prod`)\n- `pnpm build` – Build the project for production (`nhb-build`)\n- `pnpm format` – Format the codebase (`nhb-format`)\n- `pnpm lint` – Lint the code (`nhb-lint`)\n- `pnpm fix` – Auto‑fix lint issues (`nhb-fix`)\n- `pnpm commit` – Guided commit workflow (`nhb-commit`)\n- `pnpm count` – Count exports (`nhb-count`)\n- `pnpm module` – Scaffold new modules (`nhb-module`)\n\n---\n\n## ⚙️ CI/CD Workflow\n\nA ready‑to‑use **GitHub Actions workflow** is included in:\n\n```text\n.github/workflows/publish.yml\n```\n\n✅ **What it does:**\n\n- Runs on push to your main branch\n- Builds your project\n- Deploys automatically to **Vercel** (configured via `vercel.json`)\n\n✅ **How to use:**\n\n1. Push your project to a GitHub repository.\n2. Add your Vercel tokens/secrets as GitHub repository secrets:\n    Go to `Settings \u003e\u003e Secrets and variables \u003e\u003e Actions \u003e\u003e Repository secrets` and add these variables:\n    - `VERCEL_ORG_ID`\n    - `VERCEL_PROJECT_ID`\n    - `VERCEL_TOKEN`\n3. Every time you push to `main` and _version is updated_, GitHub Actions will trigger and deploy your server to Vercel.\n\nYou can customize the workflow to fit your own CI/CD needs (e.g., change branches, add tests, deploy elsewhere).\n\n---\n\nMade with ❤️ by [Nazmul Hassan](https://github.com/nazmul-nhb)\n\n**Powered by `nhb-express`** 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnazmul-nhb%2Ftest-school-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnazmul-nhb%2Ftest-school-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnazmul-nhb%2Ftest-school-server/lists"}