Get involved: Discord • Website • Issues
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.
- Ruby >3 (see
Gemfile) - PostgreSQL >9.3 (ideally, latest stable version)
After cloning the repo, the basic setup commands are:
cd caley
cp .env.example .env
bundle install
rails db:setup
bin/devAnd visit http://localhost:3000 to see the app. You can use the following credentials to log in (generated by DB seed):
Email: user@caley.local Password: password
For further instructions, see guides below.
This is 100% optional and meant for devs who don't want to worry about installing requirements manually for their platform. You can follow this guide to learn more about Dev Containers.
Please visit our Mac dev setup guide.
Please visit our Linux dev setup guide.
Please visit our Windows dev setup guide.
In development, we use letter_opener to automatically open emails in your browser. When an email sends locally, a new browser tab will open with a preview.
Before contributing, you'll likely find it helpful to understand context and general vision/direction.
Once you've done that, please visit our contributing guide to get started!
Our long term goal is to make self-hosting as easy as possible. That said, during these early stages of building the product, we are focusing our efforts on development.
We will update this section as we get closer to an initial release.
Please see our guide on self hosting here.
Caley.io is distributed under an AGPLv3 license.