Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/un/inbox

Modern email for teams and professionals. A replacement for outdated email technology and tools. Alt to hey.com, front.com, missiveapp.com
https://github.com/un/inbox

chat communication communication-systems conversations coss email emails infrastructure nuxt nuxt3 platform self-hosted smtp-client vuejs

Last synced: about 1 month ago
JSON representation

Modern email for teams and professionals. A replacement for outdated email technology and tools. Alt to hey.com, front.com, missiveapp.com

Awesome Lists containing this project

README

        


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

---

## :construction: 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](https://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:

- [Next JS](https://nextjs.org/) React based FrontEnd & Backend + modules
- [Hono](https://hono.dev/) Public API + Misc tooling
- [Tailwind](https://tailwindcss.com/) CSS Engine
- [tRPC](https://trpc.io/) Typesafe APIs
- [DrizzleORM](https://orm.drizzle.team/) ORM + MySQL

## 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.

- Node.js (Version: >=20.x)
- NVM (Node Version Manager) (see https://github.com/nvm-sh/nvm)
- Docker
- pnpm (Version >= 9.x) (see https://pnpm.io/installation)

### 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](https://github.com/un/inbox/blob/main/LICENSE). To clone in a private repository, contact us to acquire a commercial license

```sh
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](https://cal.com/docs/how-to-guides/how-to-troubleshoot-symbolic-link-issues-on-windows#enable-symbolic-links) for more details.

2. Go to the project folder

```sh
cd UnInbox
```

3. Check and install the correct node/pnpm versions

```sh
nvm install
```

4. Install packages with pnpm

```sh
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

```sh
cp .env.local.example .env.local
```

windows

```sh
copy .env.local.example .env.local
```

6. Start the docker containers

```sh
pnpm run docker:up
```

7. Sync the schema with the database:

```sh
pnpm run db:push
```

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

```sh
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