melBee is the awesome email customizer in Japan. It is the only html email customizer that is available in Japanese as of September 22nd 2022. melBee helps individuals and small businesses create html rich emails easily, and provides the capacity of analyzing data of the sent emails.

melBee provides the following features:

• Fully customizable newsletter maker
• Able to store customized templates and view sent history
• Draft auto-saver while editing template
• Simple to add marketing tools such as Google Analytics and SNS
• Unsubscribe option for newsletter receivers

Frontend

• TypeScript
• React
• Tailwind CSS
• tinyMCE

Backend

• Python
• FastAPI
• SQLAlchemy
• bcrypt
• postgresSQL

Thomas Hofman Full-Stack Engineer

Tomomi Kugai Frontend Engineer / Designer

Hiro Kanetake Frontend Engineer

Julio Quiezi Backend Engineer

Kurumi Muto Backend Engineer

If you want to try the deployed app, go to https://melbee.herokuapp.com/!

If you want to make a copy up to your local environment to run the app locally, follow the steps below.

Firstly, please clone the repo.

git clone [email protected]:melBee-newsletter/melBee.git

Once you cloned it, let's get the backend and frontend servers start running.

Go to melBee/backend, and set up the virtual environmt.

python3 -m venv env

If you're using Mac terminal or Windows Bash, run:

source ./env/bin/activate

If you're using Windows PowerShell, run:

.\env\Scripts\Activate.ps1

Go to melBee/backend, and install the libraries we use.

pip3 install -r requirements.txt

Go to your Google Account setting page and create an app password.

Open up the local postgreSQL by running psql and create a database called "melbee".

CREATE DATABASE melbee;

Go to melBee/backend/app/database, and create a .env.local file and add information below.

DATABASE_URL=postgresql://YOUR DB USERNAME:YOUR DB PASSWORD@localhost/melbee
EMAIL_ADDRESS="YOUR EMAIL"
EMAIL_PASSWORD="YOUR APP PASSWORD"

In melBee/backend/app, run:

uvicorn main:app --reload

Go tomelBee/frontend, and install the dependencies listed in package.json by running:

npm install 

Start the React server by running:

npm run dev