DevPulse REST API

Internal Tech Issue & Feature Tracker

A collaborative platform for software teams to report bugs, suggest features, and coordinate resolutions.

Live Link

• Production Link

Tech Stack

Language: Typescript & Javascript

Server: Node, ExpressJS

DataBase: NeonDB & PostgreSql

Security: JWT & BcryptJs

Deployment: Vercel

File Structure

DEVPULSE/
├── node_modules/
└── src/
    ├── config/
    │   └── env.config.ts
    ├── db/
    │   └── dbConnection.ts
    ├── middleware/
    │   ├── authMiddleware.ts
    │   └── checkRole.ts
    ├── modules/
    │   ├── auth/
    │   │   ├── auth.controller.ts
    │   │   ├── auth.interface.ts
    │   │   ├── auth.route.ts
    │   │   └── auth.service.ts
    │   └── issues/
    │       ├── issues.controller.ts
    │       ├── issues.interface.ts
    │       ├── issues.route.ts
    │       └── issues.service.ts
    ├── types/
    │   ├── express.d.ts
    │   └── types.ts
    ├── utils/
    │   ├── globalErrorHandler.ts
    │   ├── jwt.ts
    │   └── sendResponse.ts
    ├── app.ts
    └── server.ts
├── .env
├── .env.example.md
├── .gitignore
├── package-lock.json
├── package.json
├── README.md
└── tsconfig.json

Run this project locally

first clone this project

  https://github.com/mdabdurrahman07/devPulse.git
  cd devpulse

then install all dependencis

  npm run install

then set the .env (check .env.example.md)

  PORT=5000
  DB_CONNECTION_STRING=ENTER YOUR NEONDB CONNECTION DB_CONNECTION_STRING
  JWT_ACCESS_SECRET_TOKEN=ENTER YOUR JWT ACCESS SECRET KEY
  JWT_REFRESH_SECRET_TOKEN=ENTER YOU JWT REFRESH SECRET KEY
  NODE_ENV=development

lastly to run this project use

  npm run dev

API Documentation

Authentication Endpoints

Method	Endpoint	Description
POST	/api/auth/signup	Register a new user.
POST	/api/auth/login	Log in an existing user.

---

Issue Endpoints

Method	Endpoint	Description	Access Control
POST	/api/issues/	Create a new issue.	Contributor or Maintainer only.
GET	/api/issues/	Retrieve all issues.	Authenticated users.
GET	/api/issues/:id	Retrieve a single issue.	Authenticated users.
PUT/PATCH	/api/issues/:id	Update an issue.	Maintainer (All) or Contributor (Own issue & status is open).
DELETE	/api/issues/:id	Delete an issue.	Maintainer only.

---

Permission Logic

• Creation: Only users with roles contributor or maintainer can post issues.
• Updates:
  • Maintainers have full administrative rights to update any issue.
  • Contributors can only edit their own issues if the status is currently set to open.
• Deletion: Restricted strictly to users with the maintainer role.

Demo User and Admin

Demo user credentails

• email: user@gmail.com
• password: User123456

Demo admin credentails

• email: admin@gmail.com
• password: Admin123456

Author

• @mdabdurrahman