YouGotMail

Open Source SMTP server built with Node.js and nodemailer.

📖 Table of Contents

1. Description
2. Features
3. Live Demo
4. Technologies
5. Quick Install
6. How to Use
7. Contributing
8. License

📝 Description

YouGotMail is an open-source SMTP server built with Node.js and nodemailer, offering fast, flexible email delivery. Ideal for notification systems, newsletter automation, and custom email workflows.

🚀 Features

• Configurable SMTP transport for customizable email sending.
• CORS support and environment variables for scalability.
• Clean separation of backend and frontend code.
• Modular architecture ready for extension.

🎥 Live Demo

Coming soon: dashboard access and delivery metrics.

🛠 Technologies

• Backend: Node.js, Express, nodemailer, CORS, dotenv.
• Frontend: React.js, Vite, Axios, ESLint, React Hooks.
• Development: nodemon, vite, ESLint plugins.

⚙️ Quick Install

Prerequisite: Node.js and npm installed.

Backend Setup

cd server
npm install cors dotenv express nodemailer nodemon

Frontend Setup

cd client
npm install axios react react-dom
npm install --save-dev @eslint/js @types/react @types/react-dom @vitejs/plugin-react eslint eslint-plugin-react-hooks eslint-plugin-react-refresh globals vite

▶️ How to Use

Backend (Server Side)

Configure server port in .env:

PORT=4000  

Default: http://localhost:4000

Configure SMTP credentials in .env:

SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_USER=user@example.com
SMTP_PASS=supersecret

Start Backend

cd server
npm start

Frontend (Client Side)

Start Frontend

cd client
npm run dev

Default: http://localhost:5173

🤝 Contributing

1. Fork and create a branch: git checkout -b feature/your-feature.
2. Commit changes: git commit -m "feat: concise description".
3. Push to branch: git push origin feature/your-feature.
4. Open a Pull Request.

Contributions open! 🚀

📝 License

MIT © 2025 YouGotMail