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.

Introduction

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.

Setting up locally

1. Install dependencies: bun install.
2. Create D1 database using wrangler d1 create shrimp-db, copy it's ID and replace it in wrangler.toml.
3. Copy wrangler.toml.example to wrangler.toml.
4. Run migrations using wrangler d1 migrations apply shrimp-db.
5. Start development server: bun dev.

Deploy to Cloudflare

1. Build apps using bun build.
2. Create JWT_SECRET environment variable using: openssl rand -base64 48 | wrangler secret put JWT_SECRET.
3. Deploy backend using: wrangler deploy.
4. Deploy frontend using wrangler pages deploy out.

License

Released under MIT license.