Skip to content
/ xmail Public

Simple, modern, lightweight & fast web-based email client.

License

Notifications You must be signed in to change notification settings

open-xyz/xmail

Repository files navigation

Xmail

Overview

Xmail is a secure, developer-friendly email client, focused on providing a seamless and private communication experience. Our project, built with Node.js, Express.js, MongoDB/PostgreSQL for the backend, and Next.js for the frontend, is dedicated to ensuring user privacy and data security. Xmail is an open-source project, licensed under the GNU General Public License version 3 (GPLv3), promoting community collaboration and software freedom.

overview : https://app.eraser.io/workspace/4wdnMEzat7kA5eWaOOIb?origin=share

Features

  • Secure email communication
  • User-friendly interface
  • End-to-end encryption
  • Customizable settings

Getting Started

Prerequisites

Before setting up Xmail, ensure you have the following installed:

  • Node.js (latest version)
  • npm or yarn
  • Git

Installation

  1. Clone the Repository
    git clone https://github.com/your-username/xmail.git
    cd xmail

Running the Application

  1. Start the Backend Server Navigate to the backend directory and install dependencies:

    npm start
    
  2. Launch the Frontend Server In a separate terminal, navigate to the frontend directory and install dependencies:

    npm run dev
    

This will start the frontend development server, accessible at > http://localhost:3000.

Contributing

We welcome contributions to Xmail! Please read our Contributing Guidelines for details on our code of conduct and the process for submitting pull requests.

License

Xmail is licensed under the GNU General Public License version 3 (GPLv3). This license permits you to use, modify, and distribute the software, as long as all modifications and derivative works are also licensed under GPLv3. For more information, see the LICENSE file in this repository.