![Shrimp Banner](https://private-user-images.githubusercontent.com/36205125/308137710-499fb140-7043-4ae4-932a-df477cbe04a3.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTgzMjM4ODIsIm5iZiI6MTcxODMyMzU4MiwicGF0aCI6Ii8zNjIwNTEyNS8zMDgxMzc3MTAtNDk5ZmIxNDAtNzA0My00YWU0LTkzMmEtZGY0NzdjYmUwNGEzLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA2MTQlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNjE0VDAwMDYyMlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWNmOWQ0ZTY3ODg1MzE0M2MwNDdjMDdiNGU4ZjQ4NzMzOGUxMmUxODQ5MmIyY2E2OGY5ZTlhNjU1ZDY3NTdlYzEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.GnXQY1l9X5DMD1tzx-d53ss6ISKXy-t1H8Tl5Qlzfww)
Introduction · Setting up locally · Deploy to Cloudflare
Note
Shrimp is in very early development stage. Many features still aren't implemented, contributions of any kind are very welcome.
Shrimp is an fully-featured email service, fully hosted on Cloudflare Workers. It supports adding multiple domains, sending emails from them, receiving and forwarding emails.
- Install dependencies:
bun install
. - Create D1 database using
wrangler d1 create shrimp-db
, copy it's ID and replace it inwrangler.toml
. - Copy
wrangler.toml.example
towrangler.toml
. - Run migrations using
wrangler d1 migrations apply shrimp-db
. - Start development server:
bun dev
.
- Build apps using
bun build
. - Create
JWT_SECRET
environment variable using:openssl rand -base64 48 | wrangler secret put JWT_SECRET
. - Deploy backend using:
wrangler deploy
. - Deploy frontend using
wrangler pages deploy out
.
Released under MIT license.