https://github.com/mihir2006/mern-backend-starter
MERN Backend Starter Template
https://github.com/mihir2006/mern-backend-starter
backend-starter expressjs javascript mern middleware mongodb multer nodejs
Last synced: 2 months ago
JSON representation
MERN Backend Starter Template
- Host: GitHub
- URL: https://github.com/mihir2006/mern-backend-starter
- Owner: MIHIR2006
- Created: 2024-07-03T14:14:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-08T19:01:33.000Z (2 months ago)
- Last Synced: 2025-03-08T19:25:41.028Z (2 months ago)
- Topics: backend-starter, expressjs, javascript, mern, middleware, mongodb, multer, nodejs
- Language: JavaScript
- Homepage:
- Size: 4.67 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# MERN Backend Starter Template
## Tech Stack
[](https://skillicons.dev)
## Overview
This repository provides a **MERN** backend starter template featuring **Express** and **MongoDB**. It includes **authentication** (JWT-based) and **authorization** (role-based access control), making it easy to start building secure RESTful APIs for your application.
## Features
- **Express** for handling API routes and middleware.
- **MongoDB** for database integration using **Mongoose** ORM.
- **JWT Authentication** to manage user login and sessions.
- **Role-based Authorization** to control access to certain routes (e.g., Admin, User).
- **CORS** support for development environments.
- Configured with **Environment Variables** for sensitive data management.
## Prerequisites
Before you begin, ensure that you have the following tools installed:
- [Node.js](https://nodejs.org/) (v12 or higher)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
- A **MongoDB** instance (local or cloud, e.g., [MongoDB Atlas](https://www.mongodb.com/cloud/atlas))
## Folder Structure
```
└── src
└── controllers
└── user.controller.js
└── db
└── index.js
└── middlewares
└── auth.middleware.js
└── multer.middleware.js
└── models
└── User.model.js
└── video.model.js
└── routes
└── user.routes.js
└── utils
└── ApiError.js
└── ApiResponse.js
└── asyncHandler.js
└── cloudinary.js
└── app.js
└── constants.js
└── index.js
```
## Getting Started
### Clone the Repository
Clone the repository to your local machine:
```bash
https://github.com/MIHIR2006/Backend-project.git
cd Backend-project.git
```
## Install Dependencies
```
npm install
# or
yarn install
```
## Configure Environment Variables
```
PORT=8000 # Server Port
MONGODB_URI=mongodb+srv://:@clustername.mongodb.net/
CORS_ORIGIN=* # Adjust this based on the allowed origins
ACCESS_TOKEN_SECRET= # Set a strong, random string as the access token secret
ACCESS_TOKEN_EXPIRY=1d # Expiry time for access tokens (e.g., 1d, 1h, 7d)
REFRESH_TOKEN_SECRET= # Set a strong, random string as the refresh token secret
REFRESH_TOKEN_EXPIRY=10d # Expiry time for refresh tokens (e.g., 10d, 30d)
CLOUDINARY_CLOUD_NAME= # Cloud name from your Cloudinary account
CLOUDINARY_API_KEY= # API Key from your Cloudinary account
CLOUDINARY_API_SECRET= # API Secret from your Cloudinary account
```
## Start the Server
```
npm run dev
# or
yarn run dev
```