Skip to content

Files

Latest commit

Oct 9, 2024
27907ea · Oct 9, 2024

History

History

frontend

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Oct 7, 2024
Oct 4, 2024
Oct 4, 2024
Oct 9, 2024
Oct 7, 2024
Oct 9, 2024
Oct 4, 2024
Oct 4, 2024
Oct 4, 2024
Oct 4, 2024
Oct 8, 2024
Oct 4, 2024
Oct 9, 2024
Oct 7, 2024
Oct 4, 2024
Oct 4, 2024
Oct 4, 2024
Oct 7, 2024
Oct 4, 2024
Oct 7, 2024
Oct 6, 2024
Oct 5, 2024
Oct 7, 2024

AmazingMail Frontend - Next.js Powered Email Marketing Platform

AmazingMail Logo

Next.js React TypeScript Tailwind CSS

Welcome to the frontend repository of AmazingMail, a cutting-edge email marketing platform built with Next.js. This repository contains the user interface and client-side logic for our powerful cold email system.

🚀 Features

  • 📊 Interactive Dashboard: Real-time overview of campaign performance and key metrics.
  • 📧 Email Campaign Manager: Intuitive interface for creating, editing, and managing email campaigns.
  • 🎨 Email Template Designer: Drag-and-drop editor for creating stunning, responsive email templates.
  • 📈 Analytics Visualization: Beautiful charts and graphs for in-depth campaign analysis.
  • 🔒 User Authentication: Secure login and user management system.
  • 🌓 Dark Mode Support: Eye-friendly dark theme for comfortable usage in low-light environments.
  • 📱 Responsive Design: Seamless experience across desktop, tablet, and mobile devices.

🛠 Tech Stack

🚦 Getting Started

Prerequisites

  • Node.js 14.0 or later
  • npm or yarn

Installation

  1. Clone the repository:

    git clone https://github.com/amazingmail/frontend.git
    cd frontend
  2. Install dependencies:

    npm install
    # or
    yarn install
  3. Set up environment variables: Create a .env.local file in the root directory and add the following:

    NEXT_PUBLIC_API_URL=http://localhost:5000/api
    NEXT_PUBLIC_SUPABASE_URL=your_supabase_project_url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
  4. Run the development server:

    npm run dev
    # or
    yarn dev
  5. Open http://localhost:3000 in your browser to see the application.

📁 Project Structure

/
├── app/                # Next.js 13 App Router
│   ├── api/            # API routes
│   ├── (auth)/         # Authentication pages
│   ├── dashboard/      # Dashboard pages
│   ├── campaigns/      # Campaign management pages
│   └── templates/      # Email template pages
├── components/         # Reusable React components
├── hooks/              # Custom React hooks
├── lib/                # Utility functions and services
├── styles/             # Global styles and Tailwind config
├── types/              # TypeScript type definitions
└── tests/              # Test files

🧪 Running Tests

To run the test suite:

npm test
# or
yarn test

🔧 Scripts

  • npm run dev: Start the development server
  • npm run build: Build the production application
  • npm start: Start the production server
  • npm run lint: Run ESLint
  • npm run type-check: Run TypeScript compiler check

🤝 Contributing

We welcome contributions to AmazingMail! Please see our Contributing Guide for more details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgements


Built with ❤️ by the AmazingMail Team