Skip to content

Latest commit

Β 

History

History
113 lines (77 loc) Β· 3.17 KB

File metadata and controls

113 lines (77 loc) Β· 3.17 KB

Email Encode

MIT License Build with Vite Node.js npm

A simple email encoder built with vanilla JavaScript and TypeScript using Vite for bundling.


πŸ“„ License

This project is licensed under the MIT License.

You are free to:

  • βœ… Use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software
  • βœ… Use the project for personal, educational, internal, or commercial purposes
  • βœ… Credit is appreciated but not legally required
  • ❌ The software is provided "as is", without warranty of any kind

For details, see the LICENSE file.


πŸš€ Features

  • Simple email encoding tool
  • Built with TypeScript and vanilla JS
  • Uses Vite for fast, modern development and bundling
  • Clean and minimal design powered by Pico.css

πŸ›  Tech Stack

  • Frontend: Vanilla JavaScript, TypeScript, Vite, Pico.css
  • Bundler: Vite
  • Build Tool: npm (or yarn/pnpm, depending on your setup)

πŸ“¦ Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (version 16 or higher)
  • npm (version 8 or higher)

Optionally:


βš™οΈ Getting Started

  1. Clone the Repository

    git clone https://github.com/yourusername/email-encode.git
    cd email-encode
  2. Install Dependencies

    npm install
  3. Start Development Server

    npm run dev

    This will start Vite's development server on http://localhost:3000.

  4. Open in Browser

    • Open your browser and go to http://localhost:3000 to see the app in action!

πŸ“œ NPM Scripts

Command Description
npm run dev Starts Vite development server
npm run build Builds the production version of the app
npm run serve Serves the production build
npm run lint Runs TypeScript and JavaScript linting

βœ… Notes

  • The app uses Pico.css for clean, minimal styling.
  • This project is designed to be simple and easy to extend. It’s meant for educational purposes or to integrate into larger projects.

✨ Acknowledgments

  • Pico.css for the minimal, classless CSS framework.
  • Vite for fast and modern bundling.
  • Shields.io for providing the awesome badges.
  • Awesome README β€” For formatting inspiration

πŸš€ Deployment (Coming Soon)

TBD


πŸ“Œ TODO Highlights

  • Add email validation
  • Implement better UX/UI for results display
  • Add more email-related features (e.g., multiple cc, bcc)