shaonu-authkit 1.0.1 → 1.0.2

package/README.md

@@ -0,0 +1,133 @@
+# 🔐 shaonu-authkit
+
+A CLI tool to instantly scaffold a full **Express + MongoDB** Authentication Service.
+
+Just one command and your auth backend is ready!
+
+## 🚀 Quick Start
+
+```bash
+npx shaonu-authkit
+```
+
+## 📋 What It Does
+
+When you run the command, it will ask you:
+
+- 📁 Project name
+- 🍃 MongoDB URI
+- 🔑 JWT Secret
+- 🚀 Port number
+- 📦 Package manager (npm / yarn / pnpm)
+
+Then it will:
+
+- ✅ Create your project folder
+- ✅ Create the full auth service template
+- ✅ Generate `.env` file with your values
+- ✅ Install all dependencies automatically
+
+## 📡 API Routes
+
+| Method | Route | Description | Protected |
+|--------|-------|-------------|-----------|
+| POST | `/api/auth/register` | Register new user | ❌ |
+| POST | `/api/auth/login` | Login user | ❌ |
+| POST | `/api/auth/logout` | Logout user | ✅ |
+
+## 📂 Project Structure
+
+```
+your-project/
+├── src/
+│   ├── config/
+│   │   └── db.js              → MongoDB connection
+│   ├── controllers/
+│   │   └── auth.controller.js → Register, Login, Logout logic
+│   ├── models/
+│   │   └── user.model.js      → User schema
+│   ├── routes/
+│       └── auth.routes.js     → API routes
+│   
+├── app.js                     → Express app entry point
+├── .env                       → Your environment variables
+└── package.json
+```
+
+## ⚙️ Environment Variables
+
+After setup, your `.env` file will look like:
+
+```env
+PORT=5000
+MONGO_URI=mongodb://localhost:27017/authkit
+JWT_SECRET=your-secret-key
+JWT_EXPIRE=7d
+NODE_ENV=development
+```
+
+## 📦 Dependencies Used
+
+| Package | Purpose |
+|---------|---------|
+| `express` | Web framework |
+| `mongoose` | MongoDB ODM |
+| `bcryptjs` | Password hashing |
+| `jsonwebtoken` | JWT tokens |
+| `cookie-parser` | Cookie handling |
+| `dotenv` | Environment variables |
+| `nodemon` | Auto restart in dev |
+
+## 🧪 Test Your API
+
+### Register
+```bash
+curl -X POST http://localhost:3000/api/auth/register \
+  -H "Content-Type: application/json" \
+  -d '{"name": "John", "email": "john@example.com", "password": "123456"}'
+```
+
+### Login
+```bash
+curl -X POST http://localhost:3000/api/auth/login \
+  -H "Content-Type: application/json" \
+  -d '{"email": "john@example.com", "password": "123456"}'
+```
+
+### Logout
+```bash
+curl -X POST http://localhost:3000/api/auth/logout \
+  -H "Authorization: Bearer YOUR_TOKEN_HERE"
+```
+
+## 🔐 Security Features
+
+- ✅ Passwords hashed with **bcryptjs** (12 salt rounds)
+- ✅ JWT stored in **httpOnly cookie** (XSS protection)
+- ✅ **sameSite: strict** cookie (CSRF protection)
+- ✅ Password never returned in API responses
+- ✅ Token invalidated on logout
+
+
+## 🔄 Get Started After Setup
+
+```bash
+cd your-project-name
+npm run dev
+```
+
+Server runs on:
+```
+http://localhost:3000
+```
+
+## 👨‍💻 Author
+
+Made with ❤️ by **Shaonu**
+
+- GitHub: [@shaonu](https://github.com/mrsaxena01)
+- NPM: [shaonu-authkit](https://www.npmjs.com/package/shaonu-authkit)
+
+## 📄 License
+
+MIT License — free to use in any project!

package/bin/index.js

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-
 import chalk from 'chalk';
 import inquirer from 'inquirer';
 import ora from 'ora';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "shaonu-authkit",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "CLI to scaffold a full Express + MongoDB Auth Service",
     "type": "module",
     "bin": {