https://github.com/backendexpert/mern-mvc-gen
NPM Package
https://github.com/backendexpert/mern-mvc-gen
mern-stack node-package-manager nodejs npm npm-package
Last synced: about 1 month ago
JSON representation
NPM Package
- Host: GitHub
- URL: https://github.com/backendexpert/mern-mvc-gen
- Owner: BackendExpert
- Created: 2025-03-24T13:45:14.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-01T00:45:05.000Z (about 1 year ago)
- Last Synced: 2025-04-01T01:25:08.386Z (about 1 year ago)
- Topics: mern-stack, node-package-manager, nodejs, npm, npm-package
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/mern-mvc-gen
- Size: 195 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MERN-MVC-GEN
- A helper toolkit for fast MERN MVC development. Easily generate controllers and integrate authentication functions like signup and signin and also auth and Image Upload Middlewares.
## 📦 Installation
### Install via npm:
```bash
npm install merngen
```
## IMPORTANT
1. in Signup function required feilds are unique fields in Your Model
2. You must need to create frontend veriables as same as in Your Model
(if not got errors)
## 🛠️ Features
- Lightweight and beginner-friendly
- Designed for MVC pattern in MERN applications
## Function
### SignUp
- Password Hash using `bcrypt`
### SignIn
- Check Password using `bcrypt`
- build-in authentication using `jwt` (`jsonwebtokens`)
### AuthMiddleware
- Check the authentication before access the route
- must provide a login token for this
### ImageUpload Middleware
- helps to upload images in Project
## Indetails Functions
### Signup
- Automatically extracts required fields from your Mongoose model
- Checks for existing unique values
- Validates request body
- Hashes password before saving
### Signin
- Verifies email and password
- Returns a JWT token with user ID and role if authentication is successful
### AuthMiddleware
- Must need login token to run this fucntion
### ImageUpload Middleware
- image uploading (jpeg, png, gif) only accept
## 🔐 Security Practices
- Passwords hashed using bcrypt
- Tokens signed with jsonwebtoken and environment-based secret keys
- Validates required fields and handles duplicate entries
## Versioning
### 1.0.0 - 27 March 2025
- Initial release
- Develop SignUp and Sigin Functions
### 2.0.0 - 01 April 2025
- 2nd release
- Develop Auth and ImageUpload Middleware
## Common Limitations
- ImageUpload Middleware (Following image extension only can upload with this middelware)
- - jpeg
- - png
- - gif
## 🤝 Contributing
- Contributions are welcome! Please feel free to open issues or submit pull requests to improve this package.
## ScreenShorts
1. Normal SignUp
2. Using This Npm Package
- According to SignUp("User") mean "User" is Model Name
3. Auth and ImageUpload Middelware
## 👨💻 Author
Name: Jehan Weerasuriya
GitHub: [BackendExpert](https://github.com/BackendExpert)
NPM: [JehanKandy](https://www.npmjs.com/~jehankandy)
Portfolio: [JehanWeerasuriya](https://jehanweerasuriya.vercel.app/)