Teach Blog - blogging backend

The Blog Project is a backend system for a blogging platform with Admin and User roles. Admins manage users and blogs, while Users can perform CRUD operations on their own blogs. Features include secure authentication, role-based access control, and a public API with search, sort, and filter functionalities. Built with TypeScript, Node.js, Express.js, and MongoDB, the project ensures security and efficiency.

Developer

• @Rana Arju

Live API url

https://techblog-server.vercel.app/

or

https://techblog-server.vercel.app/

Video Explaination:

Technologies Used

• TypeScript: Strong typing and enhanced developer experience.
• Node.js: Runtime environment for JavaScript-based backend.
• Express.js: Framework for building RESTful APIs.
• MongoDB & Mongoose: NoSQL database with an ORM for schema validation and CRUD operations.

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

DATABASE_URL= <Your database URL>
PORT= <Port number>
NODE_ENV = development

BCRYPT_SALT_ROUNDS=
JWT_ACCESS_TOKEN=
REFRESH_TOKEN=

JWT_ACCESS_EXPIRES =
REFRESH_ACCESS_EXPIRES =

Admin login crediential:

email: admin@gmail.com
password: admin1234

Installation

Install my-project with npm

You will need to download Git and Node to run this project

• Node
• Git
• npm

Also check this out if you are new to node js.

node --version
git --version

Run Locally

Clone the project

  git clone https://github.com/rana-arju/techBlog.git

Go to the project directory

  cd techBlog

Install dependencies

  npm install

Start the server

  npm run dev

API Endpoint

Registration user

  POST /api/auth/register

User Example

Request Body:

{
  "name": "John Doe",
  "email": "john@example.com",
  "password": "securepassword"
}

Login User

  POST /api/auth/login

Get all Blogs with query or without

Example:

/api/blogs?search=technology&sortBy=createdAt&sortOrder=desc&filter=60b8f42f9c2a3c9b7cbd4f18

  GET /api/blogs

Post Blog (only login user can post blog)

  POST /api/blogs

Blog example:

Request Body:

{
  "title": "My First Blog",
  "content": "This is the content of my blog."
}

Delete own blog

  DELETE /api/blogs/:id

Update own single blog

  PATCH /api/blogs/:id

Blog example:

Request Body:

{
  "title": "Updated Blog Title",
  "content": "Updated content."
}

Admin Action API

Blocked any user

  PATCH /api/admin/users/:userId/block

Delete Users blog

  DELETE /api/admin/blogs/:id

Folder Structure 📂

├── README.md
├── tsconfig.json
├── .env
├── package-lock.json
├── package.json
├── src
│   ├── App.ts
│   ├── server.ts
│   └── app
│      ├── config
│      │    └── index.ts
|      ├── builder
│      │    └── QueryBuilder.ts
|      ├── errors
│      │    └── error all files
|      ├── middleware
│      │    └── auth, globalErrorHandler,notFound and validationRequest file
│      └── modules
│         └── Admin
|         |    ├── admin.controller.ts
|         |    ├── admin.service.ts
|         |    ├── admin.route.ts
│         └── Auth
|               ├── auth.controller.ts
|               ├── auth.schema.ts
|               ├── auth.interface.ts
|               ├── auth.service.ts
|               ├── auth.utils.ts
|               ├── auth.validation.ts
|               └── auth.route.ts
│         └── Blog
|               ├── blog.controller.ts
|               ├── blog.schema.ts
|               ├── blog.interface.ts
|               ├── blog.service.ts
|               ├── blog.validation.ts
|               └── blog.route.ts
│      └── routes
│         └── index.ts
│      └── utils
│         └── catchAsync.ts and sendResponse.ts
│
├──  vercel.json
├──  eslint.config.mjs
├── .gitignore
├── .prettierigmore
└── .prettierrc

---

Packages Used 📦

Used Package List
express js
mongoose
typescript
JWT
jsonWebToken
bcrypt
Zod
cors
dotenv
prettier
eslint__js

---