Skip to content

maskjelly/punkmail

Repository files navigation

PunkMail

PunkMail is a Next.js-based email client with a punk aesthetic.

Getting Started

To set up and run PunkMail locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/yourusername/punkmail.git
    cd punkmail
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Set up environment variables: Create a .env.local file in the root directory and add necessary variables (e.g., API keys).

    THE MOST IMPORTANT OF ALL

    SMTP_USER= yourgmail@gmail.com SMTP_PASS = yourSMTPpassword!

` Steps to get the # SMTP_PASS for Gmail:

Go to your Google Account settings. Navigate to Security. Under "Signing in to Google," enable 2-Step Verification if you haven't already. After enabling 2FA, go to the App Passwords section. Create a new app password, selecting Mail as the app and your device as the one you're generating it for. Google will provide a 16-character app password, which is your SMTP_PASS. `

  1. Run the development server:

    npm run dev
    # or
    yarn dev
  2. Open http://localhost:3000 in your browser to see PunkMail in action.

Features

  • Punk-themed email interface
  • [Add other key features of PunkMail]

Tech Stack

  • Next.js - React framework for production
  • React - JavaScript library for building user interfaces
  • TypeScript - Typed superset of JavaScript
  • Tailwind CSS - Utility-first CSS framework

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

[Specify the license for PunkMail]

Learn More

To learn more about the technologies used in this project:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published