Code Monkey home page Code Monkey logo

assistant-overmail's Introduction

Assistant-OverMail

Assistant-OverMail is an open-source Django application designed to simplify your workflow by emailing [email protected] (or any domain name if you self-host) and getting a response back from GPT-4.

You can use this to use GPT-4 privately, go around employers' blocks, or simply as a short-cut to deal with emails in the inbox. You can try it at: overmail.ai

For self-hosting. You will need Docker and Docker Compose for easy setup and deployment. The app integrates with Stripe for fiat payments, OpenNode for Bitcoin payments, and any mailing provider such mailgun, sendgrid, or AWS SES.

Updates

  • 4/15/24: Removed unneccesary tailwinds, allauth dependency & custom Postgres Docker file

  • 2/28/24: Example Nginx for self-hosting

  • 2/27/24: Response now come back in markdown

  • 2/22/24: You can now respond to the Assistant email for follow up on requests

Installation

Follow these steps to get Assistant-OverMail up and running:

  1. Clone the repository:
git clone https://github.com/jonathan-adly/assistant-overmail.git
cd assistant-overmail
  1. Set up environment variables:

Copy the .example.env file to .env or .dev.env for development settings.

cp .example.env .env
  1. Launch with Docker Compose:

    • Ensure Docker and Docker Compose are installed on your machine.
    • Build and start the containers in detached mode:
docker-compose up -d --build

Configuration

After installation, configure the application by setting up the required environment variables in your .env or .dev.env file. This includes your Stripe API keys, OpenNode API keys, and mailing provider configurations.

Usage

With Assistant-OverMail running, access it through your browser or at localhost:8000. For production we recommend an Nginx and SSL configuration.

Integrations

Stripe

  • Create a Stripe account and obtain your API keys.
  • Add your Stripe API keys to your environment file.
  • Setup a webhook endpoint

OpenNode

  • Sign up for an OpenNode account to handle Bitcoin transactions.
  • Configure your OpenNode API keys in the environment file.

Mailing Providers

  • Choose a mailing provider (e.g., SendGrid, Mailgun) and set up an account.
  • Configure your mailing provider's API keys and settings in the environment file.
  • Setup mail receiving webhooks

Contributing

We welcome contributions!

License

Assistant-OverMail is MIT licensed.

assistant-overmail's People

Contributors

jonathan-adly avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

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.