https://github.com/devshahrukhanwar/api-shahrukh-anwar
A modern, production-ready Express.js API designed for serverless deployment on Vercel. Features MVC architecture, caching, OpenAPI docs, Neon Postgres integration, and notifications via Telegram, Brevo, and more. Perfect for job applications, portfolio showcases, and scalable SaaS backends.
https://github.com/devshahrukhanwar/api-shahrukh-anwar
api express-js javascript postgres pug smtp vercel
Last synced: 3 months ago
JSON representation
A modern, production-ready Express.js API designed for serverless deployment on Vercel. Features MVC architecture, caching, OpenAPI docs, Neon Postgres integration, and notifications via Telegram, Brevo, and more. Perfect for job applications, portfolio showcases, and scalable SaaS backends.
- Host: GitHub
- URL: https://github.com/devshahrukhanwar/api-shahrukh-anwar
- Owner: devshahrukhanwar
- License: mit
- Created: 2025-06-20T11:55:53.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-22T12:22:29.000Z (10 months ago)
- Last Synced: 2025-08-22T14:36:41.038Z (10 months ago)
- Topics: api, express-js, javascript, postgres, pug, smtp, vercel
- Language: JavaScript
- Homepage: https://api-shahrukhanwar.vercel.app/docs
- Size: 130 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Portfolio API – Express.js, Pug, Vercel, Neon Postgres, Swagger
[](https://github.com/devshahrukhanwar/shahrukh-anwar)
[](https://api-shahrukhanwar.vercel.app)
[](https://neon.com/)
[](https://api-shahrukhanwar.vercel.app/docs)
[](LICENSE)
---
## 📝 Overview
A modern, production-ready Node.js/Express portfolio API, designed for ready-to-ship serverless deployment on Vercel.
Feature robust MVC architecture, hot reload, caching, OpenAPI docs, analytics, notifications, and seamless integration with Neon Postgres.
> **Perfect for job applications, portfolio showcases, and scalable SaaS backends.**
---
## 🖥️ Frontend(UI)
This repository is backend-only. For frontend features and UI, please use the companion repository:
> **Note:** For full functionality, clone and run the frontend UI from [shahrukh-anwar](https://github.com/devshahrukhanwar/shahrukh-anwar) as well.
---
## ✨ Features
| Feature | Description |
| ------------------------------ | -------------------------------------------------------------------- |
| **Express.js** | Fast, minimalist API server |
| **Vercel Ready** | Serverless, zero-config deployment |
| **MVC Structure** | Clean separation of controllers, models, routes, services, utilities |
| **Hot Reload** | Local dev with `nodemon` and `tsc --watch` |
| **Caching** | File-based cache for serverless architecture |
| **CORS** | Secure, environment-aware CORS for local, preview, and production |
| **Database** | `Neon Postgres` (free tier, scalable) |
| **Cron Jobs** | Automated temp file cleanup (Vercel + local) |
| **OpenAPI/Swagger Docs** | Live, interactive API docs at `/docs` |
| **Notifications** | Email (Brevo), Telegram, and more |
| **API** | Telegram, Twitter, Medium, Dev.to, Brevo |
| **Analytics & Logging** | Custom utilities for request/error logging and analytics |
| **Professional Documentation** | All endpoints documented with OpenAPI |
---
## 🗂️ Project Structure
```plaintext
.
├── src/
│ ├── config/ # Application wide configs
│ ├── controllers/ # Business logic (Notification, Puppeteer, Social, Utility)
| ├── middleware/ # Middlewares to secure the routes
| ├── migrations/ # SQL migrations for Neon Postgres
│ ├── models/ # Data models (Contact, etc.)
│ ├── routes/ # API route definitions
│ ├── services/ # External integrations (Email, Telegram, etc.)
│ ├── utility/ # Cache, DB, Logging, Response, Template
│ ├── views/ # For views, email templates
│ ├── swagger.js # Swagger/OpenAPI config
│ ├── index.js # Express app entry point
├── .env.example # Environment variable template
├── vercel.json # Vercel deployment config
└── README.md
```
---
## 📚 API Documentation
- **Live Swagger UI:** [https://api-shahrukhanwar.vercel.app/docs](https://api-shahrukhanwar.vercel.app/docs)
- **OpenAPI Spec:** All endpoints are fully documented with request/response schemas, tags, and examples.
---
## 🛠️ Quick Start
### 1. Clone the Repository
```bash
git clone https://github.com/devshahrukhanwar/api-shahrukh-anwar.git
cd api-shahrukh-anwar
```
### 2. Install Dependencies
```bash
npm install
```
### 3. Configure Environment
- Copy `.env.example` to `.env` and fill in your secrets.
- Set up Neon Postgres (DB), Brevo (Email), Telegram API (Notifications), Twitter API, Dev.to
- Add your API keys for Twitter, Brevo, Telegram, etc.
### 4. Run Locally
```bash
npm run dev:all
# or
npm run dev
```
- Visit [http://localhost:3000/docs](http://localhost:3000/docs) for API docs.
### 5. Deploy to Vercel (Optional)
[](https://vercel.com/new/git/external?repository-url=https://github.com/devshahrukhanwar/api-shahrukh-anwar)
---
## 🔒 Environment Variables
See `.env.example` for all required variables:
| Key | Description |
| ------- | --------------------------------- |
| APP_ENV | Environment (local/production) |
| APP_URL | Main app URL |
| API_URL | API base URL |
| ... | (see `.env.example` for all keys) |
---
## 📦 Integrations
- **Database:** [Neon Postgres](https://neon.com)
- **Cache:** File based(Default), [Upstash Redis](https://upstash.com)
- **Email:** [Brevo](https://www.brevo.com/)
- **Social:** Twitter, Dev.to, Medium
- **Notifications:** Telegram, Email
---
## 🤝 Contact
- 📧 Email: [shahrukhanwar@proton.me](mailto:shahrukhanwar@proton.me)
- 🌐 Portfolio: [shahrukhanwar.vercel.app](https://shahrukhanwar.vercel.app)
- 💼 LinkedIn: [linkedin.com/in/devshahrukh](https://www.linkedin.com/in/devshahrukh)
- 🐦 Twitter: [x.com/devshahrukh](https://x.com/devshahrukh)
---
## 📄 License
This project is open source and available under the [MIT License](LICENSE).
---
## 💖 Sponsor & Support
If you find this project useful, star the repository, consider supporting me:
---
Developed by Shahrukh Anwar | Built with Express.js | Hosted on Vercel