{"id":24325678,"url":"https://github.com/devsubid/subid-express-app","last_synced_at":"2026-04-12T03:34:50.526Z","repository":{"id":272834996,"uuid":"917904556","full_name":"devsubid/subid-express-app","owner":"devsubid","description":"A template for express + mongodb + bun + file based routing + typescript + docker + eslint + prettier","archived":false,"fork":false,"pushed_at":"2025-01-16T22:09:21.000Z","size":50,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-27T22:49:01.018Z","etag":null,"topics":["bun","cli","docker","docker-compose","eslint","express","filebasedrouting","mongodb","prettier","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/subid-express-app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devsubid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-01-16T21:30:38.000Z","updated_at":"2025-01-16T22:09:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"522a4bc9-9098-4ebb-8764-596f3f0f6c05","html_url":"https://github.com/devsubid/subid-express-app","commit_stats":null,"previous_names":["devsubid/subid-express-app"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devsubid/subid-express-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsubid%2Fsubid-express-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsubid%2Fsubid-express-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsubid%2Fsubid-express-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsubid%2Fsubid-express-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devsubid","download_url":"https://codeload.github.com/devsubid/subid-express-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devsubid%2Fsubid-express-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31703501,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-11T21:17:31.016Z","status":"online","status_checked_at":"2026-04-12T02:00:06.763Z","response_time":58,"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":["bun","cli","docker","docker-compose","eslint","express","filebasedrouting","mongodb","prettier","typescript"],"created_at":"2025-01-17T20:18:53.856Z","updated_at":"2026-04-12T03:34:50.519Z","avatar_url":"https://github.com/devsubid.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SUBID Express App CLI\n\n**SUBID Express App CLI** is a command-line tool that helps developers quickly initialize a modern, scalable backend project using **Express.js**, **MongoDB**, and **Bun.js**. This template includes file-based routing, Docker integration, ESLint, Prettier, TypeScript, and Mongoose to jumpstart your development process.\n\n---\n\n## 🚀 Features\n\n- **Express.js**: Lightweight, fast, and flexible web framework.\n- **MongoDB + Mongoose**: Integrated schema-based data modeling and NoSQL database.\n- **Bun.js**: Ultra-fast JavaScript runtime for improved performance.\n- **File-based Routing**: Automatically map routes from the file system.\n- **Docker**: Ready-to-use Docker configuration for development and production.\n- **TypeScript**: Static typing for safer and more maintainable code.\n- **ESLint + Prettier**: Enforce code quality and consistent formatting.\n\n---\n\n## 📦 Installation\n\nYou can use `bunx` to initialize the project in seconds:\n\n```bash\nbunx subid-express-app init \u003cproject-name\u003e\n```\n\nOr install it globally:\n\n```bash\nbun install -g subid-express-app\nsubid-express-app init \u003cproject-name\u003e\n```\n\n---\n\n## 🛠️ Usage\n\n1. Run the CLI tool to initialize a new project:\n\n   ```bash\n   bunx subid-express-app init my-project\n   ```\n\n2. Navigate to the project directory:\n\n   ```bash\n   cd my-project\n   ```\n\n3. Start the development server with Bun:\n\n   ```bash\n   bun run dev\n   ```\n\n4. Build the project for production:\n\n   ```bash\n   bun run build\n   ```\n\n5. Run the production build:\n   ```bash\n   bun run start\n   ```\n\n---\n\n## 🌟 Features Overview\n\n### 1. **File-Based Routing**\n\n- Place route files in the `src/routes/` directory.\n- Automatically loaded based on file structure.\n\n### 2. **MongoDB Integration**\n\n- Mongoose ORM is pre-configured for seamless database operations.\n- Define your database models in `src/models/`.\n\n### 3. **TypeScript Support**\n\n- All TypeScript configurations are included for better code quality and maintainability.\n- Pre-configured `tsconfig.json` for a smooth development experience.\n\n### 4. **Linting and Formatting**\n\n- **ESLint**: Ensures code quality and enforces best practices.\n- **Prettier**: Automatically formats your code for consistency.\n\n### 5. **Docker**\n\n- Ready-to-use `Dockerfile` and `docker-compose.yml` for running your app in a containerized environment.\n\n---\n\n## 📁 File Structure\n\n```plaintext\nmy-project/\n├── src/\n│   ├── config/            # Configuration files for different environments\n│   ├── controllers/       # Define your controller logic\n│   ├── data/              # Seed data and database initialization scripts\n│   ├── middlewares/       # Custom middleware functions\n│   ├── models/            # Mongoose models for MongoDB\n│   ├── routes/            # File-based routing (automatically loaded)\n│   ├── services/          # Business logic and services\n│   ├── types/             # TypeScript type definitions and interfaces\n│   ├── utils/             # Utility functions\n│   └── app.ts             # Entry point of the application\n├── .env                   # Environment variables\n├── .eslint.config.js      # ESLint configuration\n├── .prettierrc            # Prettier configuration\n├── bun.build.js           # Bun.js build configuration\n├── docker-compose.yml     # Docker Compose configuration\n├── Dockerfile             # Dockerfile for containerization\n├── package.json           # Project dependencies and scripts\n├── tsconfig.json          # TypeScript configuration\n└── README.md              # Project documentation\n```\n\n### 6. **Additional Directories**\n\n- **config/**: Configuration files for different environments.\n- **data/**: Seed data and database initialization scripts.\n- **middlewares/**: Custom middleware functions (e.g., loggers, authentication).\n- **scripts/**: Database scripts for migrations and seeding.\n- **types/**: TypeScript type definitions and interfaces.\n\n---\n\n## 🐳 Docker\n\n1. Build and run the application using Docker:\n\n   ```bash\n   docker-compose up -d --build\n   ```\n\n2. Stop the containers:\n\n   ```bash\n   docker-compose down\n   ```\n\n---\n\n## 🔧 Scripts\n\n### Available Scripts\n\n- `bun run dev`: Start the development server.\n- `bun run build`: Build the application for production.\n- `bun run start`: Run the production build.\n- `bun run lint`: Lint the codebase using ESLint.\n- `bun run format`: Format the code using Prettier.\n\n---\n\n## 📖 Learn More\n\n- [Express.js Documentation](https://expressjs.com/)\n- [MongoDB Documentation](https://www.mongodb.com/docs/)\n- [Bun.js Documentation](https://bun.sh/)\n- [TypeScript Documentation](https://www.typescriptlang.org/)\n\n---\n\n## 📝 License\n\nThis project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for more details.\n\n---\n\n### 💬 Questions or Suggestions?\n\nFeel free to reach out or open an issue on the [GitHub repository](https://github.com/devsubid/subid-express-app) if you have any questions or suggestions!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsubid%2Fsubid-express-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevsubid%2Fsubid-express-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevsubid%2Fsubid-express-app/lists"}