The repo is being switched to Rails and is now located here
Repo
The open-source email client for the modern era.
Website
·
Issues
·
Kanban
·
Discord
Caley.io reimagines your inbox with a fusion of AI brilliance and unmatched efficiency. Think smarter analytics, streamlined conversations, and effortless newsletter management all in one sleek package. More than an email client, it's your unfair advantage.
The repository is based on Inbox Zero Which as inspired the newsletter and stats features
Feel free to create Issues, feature requests or anything you have in mind
The external services that are required are:
We use Postgres for the database.
You can run Postgres & Redis locally using docker-compose
docker-compose up -d # -d will run the services in the background
Create your own .env
file:
cp apps/web/.env.example apps/web/.env
cd apps/web
pnpm install
Set the environment variables in the newly created .env
. You can see a list of required variables in: apps/web/env.mjs
.
The required environment variables:
NEXTAUTH_SECRET
-- can be any random string (try using openssl rand -hex 32
for a quick secure random string)GOOGLE_CLIENT_ID
-- Google OAuth client ID. More info hereGOOGLE_CLIENT_SECRET
-- Google OAuth client secret. More info hereTINYBIRD_TOKEN
-- Admin token for your Tinybird workspace (be sure to create an instance in the GCP us-east4
region. This can also be changed via your .env
if you prefer a different region).OPENAI_API_KEY
-- Standard OpenAI API key.To run the migrations:
pnpm prisma migrate dev
Now run:
pnpm run dev
Or from the project root:
turbo dev
Open http://localhost:3000 to view it in your browser. To upgrade yourself to admin visit: http://localhost:3000/admin.
Follow the instructions here to setup the pipes
and datasources
.
Follow instructions here.
Set env var GOOGLE_PUBSUB_TOPIC_NAME
.
When creating the subscription select Push and the url should look something like: https://www.getinboxzero.com/api/google/webhook
or https://abc.ngrok-free.app/api/google/webhook
where the domain is your domain.
To run in development ngrok can be helpful:
ngrok http 3000
And then update the webhook endpoint in the Google PubSub subscriptions dashboard.
To start watching emails visit: /api/google/watch/all
.