Giter Club home page Giter Club logo

email-archiver's Introduction

Discord

This project is currently in early development, and things may break unexpectedly.

Briefbox

Briefbox is a tool for archiving emails from multiple IMAP and POP3 accounts. It provides a user-friendly web interface for managing email accounts, searching archived emails, and viewing email details along with attachments. One of the standout features of Briefbox is its advanced search functionality, which allows users to quickly find specific emails using various criteria.

image image
image image

Prerequisites

  • Python 3.x
  • Node.js
  • npm

Setup and Usage

  1. Clone the repository:

    git clone https://github.com/bandundu/email-archiver.git
  2. Navigate to the backend directory:

    cd email-archiver/backend
  3. Create a virtual environment:

    python -m venv .venv
  4. Activate the virtual environment:

    source .venv/bin/activate
  5. Install the required dependencies:

    pip install -r requirements.txt
  6. Launch the backend:

    python app.py

    The backend will start running on http://localhost:5050.

  7. Open a new terminal and navigate to the frontend directory:

    cd ../frontend/briefbox-front
  8. Install the frontend dependencies:

    npm install
  9. Start the frontend development server:

    npm start

    The frontend will be accessible at http://localhost:3000.

  10. Access the web interface by opening a web browser and navigating to http://localhost:3000.

  11. Use the web interface to add email accounts, search for emails, and view email details.

Note: I apologize for the inconvenience, but I am are currently working on improving the Docker Compose setup for a smoother deployment experience. In the meantime, please follow the above steps for a bare-metal installation.

Star History

Star History Chart

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.