Giter Club home page Giter Club logo

shrimp's Introduction

Shrimp Banner

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.

shrimp's People

Contributors

filipkania avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.