Home

Hello reader! Welcome to multi-email. There are two ways you can set up the project locally. The first method is done manually, and the second one is with docker. Let's do the manual way first:

Manual set up

Prerequisite

• Latest Node js version
• Yarn installed (npm i -g yarn)
• Mongodb installed on local system
• .env file with all required variables (check environment variables mentioned below)

mkdir multi-email
cd multi-email
git clone https://github.com/MultiEmail/backend.git
cd backend

Installing dependencies

yarn install

Run the server

yarn dev

Create admin user

yarn build
npm i -g .
multi-email-admin -e <email> -u <username> -p <password>

PSA: If you are using unix operating system than prefix all bash commands with sudo

Docker set up

Prerequisite

• Docker is installed on your local system
• .env file with all required variables (check environment variables mentioned below)

Run Server

docker compose --env-file ./.env up

To rebuild the image

docker compose --env-file ./.env up --build

Create admin user

docker ps