https://github.com/coderomm/send-anonymous-mail
Send Anonymous Mail, no data records
https://github.com/coderomm/send-anonymous-mail
axios-react expressjs mongodb nodejs nodemailer react reactjs
Last synced: 9 months ago
JSON representation
Send Anonymous Mail, no data records
- Host: GitHub
- URL: https://github.com/coderomm/send-anonymous-mail
- Owner: coderomm
- Created: 2024-07-28T15:31:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-30T03:51:16.000Z (over 1 year ago)
- Last Synced: 2025-03-23T21:14:04.875Z (9 months ago)
- Topics: axios-react, expressjs, mongodb, nodejs, nodemailer, react, reactjs
- Language: TypeScript
- Homepage: https://send-anonymous-mail.vercel.app
- Size: 125 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Sure, here's the README file in Markdown format:
```markdown
# Send Anonymous Email
This project allows users to send anonymous emails through a web interface. It consists of a frontend built with React and styled using Tailwind CSS, and a backend built with Node.js, Express, and Nodemailer.
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Environment Variables](#environment-variables)
- [Usage](#usage)
- [Deployment](#deployment)
- [Screenshots](#screenshots)
- [Contributing](#contributing)
- [License](#license)
## Features
- Send anonymous emails with a simple and clean interface.
- Email validation and form validation.
- Real-time status messages for email sending.
- Backend handling with Nodemailer and Gmail.
## Technologies Used
### Frontend
- React
- Tailwind CSS
- Axios
### Backend
- Node.js
- Express
- Nodemailer
- dotenv
- CORS
## Prerequisites
- Node.js (version 14 or higher)
- npm (version 6 or higher)
- A Gmail account with an App Password enabled for Nodemailer
## Installation
### Clone the Repository
```sh
git clone https://github.com/your-username/send-anonymous-email.git
cd send-anonymous-email
```
### Backend Setup
1. Navigate to the backend directory:
```sh
cd backend
```
2. Install dependencies:
```sh
npm install
```
3. Create a `.env` file in the `backend` directory and add your Gmail credentials:
```env
GMAIL_USER=your-email@gmail.com
GMAIL_PASS=your-app-password
```
4. Start the backend server:
```sh
npm start
```
The backend server will be running on `http://localhost:5000`.
### Frontend Setup
1. Navigate to the frontend directory:
```sh
cd ../frontend
```
2. Install dependencies:
```sh
npm install
```
3. Start the frontend development server:
```sh
npm run dev
```
The frontend will be running on `http://localhost:3000`.
## Environment Variables
### Backend
Create a `.env` file in the `backend` directory and add the following:
```env
GMAIL_USER=your-email@gmail.com
GMAIL_PASS=your-app-password
PORT=5000
```
### Frontend
No specific environment variables are required for the frontend.
## Usage
1. Open the frontend in your browser (`http://localhost:3000`).
2. Fill in the form with the recipient's email address, subject, and message.
3. Click "Send Email".
4. The status of the email will be displayed below the form.
## Deployment
### Backend
1. Push your backend code to a GitHub repository.
2. Deploy the backend to a platform like Render or Heroku.
3. Ensure the environment variables are set in the deployment environment.
### Frontend
1. Push your frontend code to a GitHub repository.
2. Deploy the frontend to a platform like Vercel or Netlify.
3. Ensure the frontend is configured to communicate with the deployed backend.
## Screenshots
*Caption for Screenshot 1*
*Caption for Screenshot 2*
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request.
1. Fork the repository.
2. Create a new branch: `git checkout -b feature-name`.
3. Make your changes and commit them: `git commit -m 'Add some feature'`.
4. Push to the branch: `git push origin feature-name`.
5. Open a pull request.
## License
This project is licensed under the MIT License.
```
Feel free to replace placeholder text like repository URLs and screenshot links with actual content.