Skip to content
This repository has been archived by the owner on Feb 16, 2023. It is now read-only.

berrysauce/microletter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

84 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

microletter-logo
GitHub repo size Libraries.io dependency status for GitHub repo GitHub last commit GitHub CodeQL status

microletter

A micro newsletter service 📨

Installation

WARNING: All dashboard links are accessable by ANYONE currently if not installed on Deta Space. Sensitive information might be viewable by anyone.

  1. Get a Deta project key at https://web.deta.sh
  2. Get your Google Password or generate an App Password (like shown here) if you're using 2 Factor Authentication
  3. Clone this repository
  4. Create a .env file with the following format in the same directory as the repository
DETA_PROJECT_KEY=YOURDETATOKEN
SMTP_PASSWORD=YOURGOOGLEPASSWORD
SMTP_USERNAME=YOURGMAILADDRESS
SMTP_SERVER=smtp.gmail.com
SMTP_PORT=465
  1. Install all Python dependencies with pip install -r requirements.txt (make sure pip -v returns a version above 3.x - if not use pip3 install -r requirements.txt)
  2. Run the code with python main.py (or with python3 main.py if pip -v returned a version under 3.x)

How to use

Go to yourdomain.com/dashboard and you'll be redirected to your dashboard.

Credits

License

microletter is a self-hostable Newsletter service. Copyright (C) 2021 Paul Haedrich (berrysauce)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

For questions, contact microletter@berrysauce.me.