Enhance README #7
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Expanded README with detailed features, installation instructions, API documentation, and security features.
README.md
Outdated
Comment on lines
10
to
19
| ## 🎯 Features | ||
|
|
||
| - 🔐 **Password Security** - Bcrypt hashing (10 salt rounds) | ||
| - ✅ **Input Validation** - Joi validation for emails, passwords, and user data | ||
| - 🔑 **JWT Authentication** - Secure token-based auth | ||
| - 📦 **MongoDB Integration** - Mongoose ORM with pagination | ||
| - 🛡️ **CORS Protection** - Cross-origin request handling | ||
| - 📝 **Request Logging** - Morgan HTTP request logger | ||
| - 📧 **Email Support** - SendGrid integration ready | ||
| - 🚀 **Production Ready** - Error handling and security best practices |
| @@ -1,14 +1,359 @@ | |||
| # root-template-express | |||
Member
There was a problem hiding this comment.
i prefer the earlier heading
README.md
Outdated
Comment on lines
21
to
29
| ## 📸 Demo | ||
|
|
||
| Here's how the API works: | ||
|
|
||
| ``` | ||
| POST /api/users - Create User | ||
| POST /api/auth/login - Login | ||
| GET /api/users - List Users (requires token) | ||
| ``` |
Member
There was a problem hiding this comment.
Not sure if this is needed. Maybe we can have autogenerated API docs
README.md
Outdated
| ``` | ||
|
|
||
| ## 🛠️ Tech Stack | ||
|
|
Member
There was a problem hiding this comment.
Not sure if this is needed. Maybe we can have autogenerated API docs
README.md
Outdated
|
|
||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/sanjana2505006/template-express-mongodb.git |
README.md
Outdated
Comment on lines
107
to
128
| ## 📚 API Documentation | ||
|
|
||
| ### Authentication Endpoints | ||
|
|
||
| #### Login | ||
| ```http | ||
| POST /api/auth/login | ||
| Content-Type: application/json | ||
| { | ||
| "email": "[email protected]", | ||
| "password": "MyPass@123", | ||
| "type": "root" | ||
| } | ||
| ``` | ||
|
|
||
| **Response:** | ||
| ```json | ||
| { | ||
| "status": true, | ||
| "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", | ||
| "user": { |
Member
There was a problem hiding this comment.
This is for lines 107 to 202. We should not add API docs here
README.md
Outdated
Comment on lines
202
to
230
| ## 📁 Project Structure | ||
|
|
||
| ``` | ||
| . | ||
| ├── controllers/ # Business logic for routes | ||
| │ ├── auth.js # Authentication logic | ||
| │ ├── user.js # User management logic | ||
| │ └── util.js # Utility functions | ||
| ├── models/ # Mongoose schemas | ||
| │ └── user.js # User schema | ||
| ├── routes/ # API route definitions | ||
| │ ├── index.js # Main router | ||
| │ ├── auth.js # Auth routes | ||
| │ ├── user.js # User routes | ||
| │ └── util.js # Utility routes | ||
| ├── middlewares/ # Custom middleware | ||
| │ ├── validateToken.js # JWT validation | ||
| │ └── allowRoot.js # Role-based access | ||
| ├── utils/ # Utility functions | ||
| │ ├── validators.js # Joi validation schemas | ||
| │ ├── generate.js # Key/secret generation | ||
| │ ├── asyncForEach.js # Async helpers | ||
| │ ├── mkdirSync.js # Directory creation | ||
| │ └── unlinkSync.js # File deletion | ||
| ├── data/ # Test data | ||
| │ └── test.http # HTTP client requests | ||
| ├── server.js # Main server file | ||
| ├── package.json # Dependencies | ||
| └── README.md # This file |
Member
There was a problem hiding this comment.
not needed, maybe we can have folder level only
Contributor
Author
|
Hi @krushndayshmookh, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes the project more beginner-friendly, clear to set up, and ready for open-source collaboration