A guide on how to run Unsend’s codebase locally
apps
directory contains the code for:
web
: Code for our dashboard and email infra
marketing
: The code for the landing page of Unsend
docs
: The documentation that you are currently reading.
packages
directory contains the code for:
eslint-config
package contains shared ESLint configuration settings
sdk
package contains typescript sdk for unsend rest api
tailwind-config
This package contains a shared Tailwind CSS configuration.
typescript-config
This package contains a shared typescript configuration
ui
This package is a collection of reusable UI components like buttons, badges, etc
Fork the repo
Clone the repo
Copy the env.example file into .env
Nextauth secret
NEXTAUTH_SECRET
Setup Github Oauth (optional)
FROM_EMAIL
set in your environment
variables. for development email link will logged in the console.GITHUB_ID
and CLIENT SECRET under GITHUB_SECRET
Setup AWS credentials (Optional)
Start the dashboard
Dashboard and Landing page will start running
Once you login with Github you will be prompted with SES settings. You will need to run cloudflare tunnel to add the callback URL
Set up your PostgreSQL and Redis database in Environment Variables
Migrate the database
Start the development server
Once you login with Github you will be prompted with SES settings. You will need to run cloudflare tunnel to add the callback URL