@patel.ajay745/exinit 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,171 @@
+# exinit
+
+Every time you start a new Express backend you end up doing the same thing. Create a folder, set up TypeScript, write the same error handler, the same async wrapper, the same response class, and then finally start working on the actual feature you wanted to build. That setup easily takes 30 minutes and it is the same 30 minutes every single time.
+
+exinit fixes that. One command and your project is ready to go.
+
+## What you get
+
+When you run exinit it asks you three questions and then creates a complete Express project for you. You choose the language (TypeScript or JavaScript), the module system if you picked JavaScript (CommonJS or ES Modules), and the package manager you want to use. After that it sets everything up and installs the dependencies automatically.
+
+The generated project comes with four utility files that most Express apps need anyway.
+
+**ApiError** is a custom error class. Instead of throwing generic errors you throw an ApiError with a status code and a message. Your error handler knows how to deal with it and sends a clean JSON response.
+
+**ApiResponse** is a response wrapper. Every successful response goes through it so your API always returns data in the same shape. The client always knows what to expect.
+
+**asyncHandler** is a wrapper for async route handlers. You wrap your async functions with it and you never have to write try catch inside a route again. Errors are automatically passed to Express.
+
+**errorHandler** is an Express error middleware. It catches every error in your app, handles ApiError instances specially, and falls back to a generic 500 for anything unexpected.
+
+## Installation
+
+You do not need to install anything globally. Just use npx.
+
+```bash
+npx @patel.ajay745/exinit my-app
+```
+
+If you are already inside the folder where you want your project, you can run it without a name and it will use the current folder.
+
+```bash
+npx @patel.ajay745/exinit
+```
+
+Both of these also work.
+
+```bash
+npx @patel.ajay745/exinit .
+cd my-project && npx @patel.ajay745/exinit
+```
+
+## Interactive prompts
+
+When you run the command you will see three prompts. Use the arrow keys to move between options and press Enter to select.
+
+```
+? Select language:          TypeScript / JavaScript
+? Choose module system:     CommonJS / ES Modules     (only appears for JavaScript)
+? Choose package manager:   npm / bun / pnpm / yarn
+```
+
+Package managers that are not installed on your machine will show up as greyed out and cannot be selected.
+
+## Project structure
+
+After exinit finishes you will have this structure inside your project folder.
+
+```
+my-app/
+├── src/
+│   ├── controllers/
+│   ├── middlewares/
+│   ├── models/
+│   ├── routes/
+│   │   └── index.ts        (sample health check route)
+│   ├── services/
+│   ├── config/
+│   ├── dto/                (TypeScript only)
+│   ├── types/              (TypeScript only)
+│   ├── utils/
+│   │   ├── apiError.ts
+│   │   ├── apiResponse.ts
+│   │   ├── asyncHandler.ts
+│   │   └── errorHandler.ts
+│   └── index.ts            (Express app entry point)
+├── .env.example
+├── .gitignore
+├── package.json
+└── tsconfig.json           (TypeScript only)
+```
+
+## Starting your project
+
+After the scaffold finishes, go into your project folder and start the dev server.
+
+```bash
+cd my-app
+npm run dev
+```
+
+Once it is running, hit this endpoint to confirm everything is working.
+
+```
+GET http://localhost:3000/api/health
+```
+
+You should get back something like this.
+
+```json
+{
+  "statusCode": 200,
+  "message": "Server is healthy",
+  "data": { "status": "ok" },
+  "success": true
+}
+```
+
+## Available scripts
+
+The generated project comes with these scripts.
+
+**TypeScript projects**
+
+```bash
+npm run dev      # starts the dev server with hot reload
+npm run build    # compiles TypeScript to JavaScript in dist/
+npm start        # runs the compiled output
+```
+
+**JavaScript projects**
+
+```bash
+npm run dev      # starts the dev server with hot reload via nodemon
+npm start        # runs the project directly with Node
+```
+
+If you chose bun, pnpm, or yarn, replace `npm run` with your package manager. For example `pnpm dev` or `bun dev`.
+
+## Using the utilities
+
+Here is a quick example of how the utilities work together in a real route.
+
+```typescript
+import { Router } from "express";
+import { asyncHandler } from "@/utils/asyncHandler";
+import { ApiResponse } from "@/utils/apiResponse";
+import { ApiError } from "@/utils/apiError";
+
+const router = Router();
+
+router.get("/user/:id", asyncHandler(async (req, res) => {
+  const user = await getUserById(req.params.id);
+
+  if (!user) {
+    throw new ApiError(404, "User not found");
+  }
+
+  res.status(200).json(new ApiResponse(200, "User fetched successfully", user));
+}));
+```
+
+If `getUserById` throws or `user` is not found, the error flows to the errorHandler automatically. No try catch needed.
+
+## Environment variables
+
+Copy the example file and fill in your values.
+
+```bash
+cp .env.example .env
+```
+
+The default variables are:
+
+```
+PORT=3000
+NODE_ENV=development
+```
+
+## Requirements
+
+Node.js version 18 or higher is required.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patel.ajay745/exinit",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Scaffold a production-ready Express project in seconds",
   "bin": {
     "exinit": "./dist/cli.js"
@@ -18,7 +18,13 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "keywords": ["express", "typescript", "boilerplate", "scaffold", "starter"],
+  "keywords": [
+    "express",
+    "typescript",
+    "boilerplate",
+    "scaffold",
+    "starter"
+  ],
   "license": "MIT",
   "devDependencies": {
     "typescript": "^5.4.5",