Skip to content

Latest commit

 

History

History
156 lines (101 loc) · 4.96 KB

README.md

File metadata and controls

156 lines (101 loc) · 4.96 KB
Raw

Join The UnInbox Discord Community Github Stars

Commits-per-month

UnInbox Logo

UnInbox

The Open Source Communication Infrastructure

To our Website & App »

UnInbox Twitter · UnInbox Discord Server

🚧 Current Status

UnInbox is Live! We are working on more features and infrastructure to make UnInbox better. Please join our Discord community to get the latest updates and to provide feedback. Join at app.uninbox.com.

About

Our core infrastructure is designed from the ground up for effective communication between you and the rest of the world.

The webapp provides a flavoured experience of what email communication would be if it was re-imagined for how we communicate today.

Features like "team collaboration", "conversation notes" and "new sender screener" are native, making communication easier and more intuitive.

Built to work with your current email infrastructure or replace it entirely.

We're not here to kill email, we're bringing it up to date, killing inboxes along the way.

UnInbox isn't another email service, its a better way to do email.

And email is just the start

Why

The first email was sent almost 45 years ago (1979). Before the invention of the mobile telephone.

Communication workflows have changed dramatically since then, but the email experience has remained the same.

The volume of emails we receive has exploded in recent years, with more noise than actual conversations.

Email is not built for today's noisy, remote, highly collaborative world.

But email is universal, so we can't force the world to replace it.

Instead, we're detaching from its legacy underpinnings, to build something modern on top.

Tech Stack

UnInbox is built with the following epic technologies & tools:

Running Locally

To get a local copy up and running, follow these simple steps.

Prerequisites

Here is what you need to be able to run UnInbox locally.

Setup

  1. Clone the repo into a public GitHub repository (or fork https://github.com/un/inbox/fork). If you plan to distribute the code, keep the source code public to comply with AGPLv3. To clone in a private repository, contact us to acquire a commercial license

    git clone https://github.com/un/inbox.git

    If you are on Windows, run the following command on gitbash with admin privileges:
    > git clone -c core.symlinks=true https://github.com/un/inbox.git
    See docs for more details.

  2. Go to the project folder

    cd UnInbox

  3. Check and install the correct node/pnpm versions

    nvm install

  4. Install packages with pnpm

    pnpm i

  5. Set up your .env.local file

    • Duplicate .env.local.example to .env.local. This file is already pre-configured for use with the local docker containers

      mac

       cp .env.local.example .env.local

      windows

       copy .env.local.example .env.local

  6. Start the docker containers

    pnpm run docker:up

  7. Sync the schema with the database:

    pnpm run db:push

  8. In another terminal window, start the app and all services

    pnpm run dev

Self Hosting

Self hosting will be possible, but requires some additional manual configuration for email. Please check out Discord community for information on how to self-host UnInbox in production