https://github.com/musiur/mmeja-backend-tamplate
A backend template having custom authentication system using JWT, express, nodemail and followed by MVC architecture in folders. Whole template is made with JavaScript having standard documentation below at repository(readme.md)
https://github.com/musiur/mmeja-backend-tamplate
express jwt-authentication mongodb mongoose nodejs nodemailer
Last synced: 4 months ago
JSON representation
A backend template having custom authentication system using JWT, express, nodemail and followed by MVC architecture in folders. Whole template is made with JavaScript having standard documentation below at repository(readme.md)
- Host: GitHub
- URL: https://github.com/musiur/mmeja-backend-tamplate
- Owner: musiur
- Created: 2023-03-06T08:17:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-24T11:47:20.000Z (over 1 year ago)
- Last Synced: 2025-01-09T04:49:03.581Z (5 months ago)
- Topics: express, jwt-authentication, mongodb, mongoose, nodejs, nodemailer
- Language: JavaScript
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📚 **mmeja-backend-tamplate**
m=mongodb
m=mongoose
e=expressjs
j=jsonwebtoken
a=authentication
# ☑️ **Installation**
```
git clone https://github.com/musiur/mmeja-backend-tamplate.git
```
# 🤿 **Let's dive into deep**
### 🏃♂️ **Getting Start:**
First of all let's make changes in `server.js`. There will find a part of code where a const array created name `allowedOrigins`.
```JS
// cross origin issue
const allowedOrigins = ["http://example1.com", "http://example2.com", "http://localhost:3000", "https://next-base-template.vercel.app"]
app.use(
cors({
origin: allowedOrigins,
})
)
```
Whatever url client we will have for our project we have to add here in this array `allowedOrigins`.
For example: Our client site link is: _https://musiur.vercle.app_. So we will have new item in the array.
```
// cross origin issue
const allowedOrigins = ["http://example1.com", "http://example2.com", "http://localhost:3000", "https://next-base-template.vercel.app", "https://musiur.vercel.app"]
```
Then, we need to make changes in files in the `configs` folder in root directory of out project.
We have two javascript files inside our `configs` folder
- database.config.js
- server.config.js
Inside our `database.config.js` file by default we have set this code:
```JS
const DatabaseConfig = {
uri:`MONGODB_DATABASE_URI`,
}
module.exports = DatabaseConfig
```
Now, we have to copy our `mongodb-uri` from mongodb connect and paste the copied `uri` into `DatabaseConfig` objects key `uri`. Also we have to create table `user` inside our database that is mentioned in that copied `uri` in **MONGODB** web or desktop application.
Let's make change to another file `server.config.js` where we have by default this code:
```JS
const ServerConfig = {
port: 8080,
secret: "Allahuakbar",
}
module.exports = ServerConfig
```
We may have whatever `port` we want and also the `secret` for `encrypting` and `decrypting` JWT for authentication.
Again, we have to make change in another folder `middlewares`. Here in this folder we have `mail.middlewares.js`. Inside this file we have:
```JS
const transporter = nodemailer.createTransport({
service: "gmail",
auth: {
user: "YOUR EMAIL",
pass: "YOUR PASS",
},
})
const mailOptions = {
from: "[email protected]",
to: toSend,
subject,
text: `Click to the click to verify your account: ${link}`,
}
```
We need to make changes with our own credentials of nodemailer here:
```JS
auth: {
user: "YOUR EMAIL",
pass: "YOUR PASS",
},
```
And also we need make changes here in this part:
```JS
const mailOptions = {
from: "[email protected]",
to: toSend,
subject,
text: `Click to the click to verify your account: ${link}`,
}
```
In `mailOptions` object we are going to deal with keys - _from and text_.
Now, we are ready to install all the packages.
Use your favorite package manager to install all of them.
Here I would prefer to have `pnpm` or, `yarn`:
```
pnpm install
```
or,
```
yarn install
```
After installing all the packages we are ready to visit our other folders to work with.
### 📂 **Folders in our project:**
```JS
---|---> configs
|---> controllers
|---> database
|---> middlewares
|---> models
|---> routes
|---> schemas
|---- server.js
// node-modules
```
### 🔑 **Account sign up:**
We have a route `/auth/signup` From client side/ application body we have to get these information in order to create an account.
```JS
{
name: "Musiur Alam Opu",
email: "[email protected]",
password: "[email protected]",
role: "user"
}
```
Here: this object should be found in `body` with `POST` method. Account will be created if there is no error and also a `verification email` will be sent to give email address above.
After verifing account in database the user account will be verified for rest of the time.
# To be continued...
## **Up next**
### 🔐 **Account sign in:**
### 🆕 **Reset password:**
### 💁 **Forget password:**
### 💬 **Other routes, controllers, schemas, models, middlewares explore:**