A micro newsletter service 📨
- 🏠 Homepage: https://microletter.cc
- 📘 Documentation: https://docs.microletter.cc
- 🪐 Install on Deta Space: https://deta.space/discovery/microletter
⚠ WARNING: All dashboard links are accessable by ANYONE currently if not installed on Deta Space. Sensitive information might be viewable by anyone.
- Get a Deta project key at https://web.deta.sh
- Get your Google Password or generate an App Password (like shown here) if you're using 2 Factor Authentication
- Clone this repository
- 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
- Install all Python dependencies with
pip install -r requirements.txt(make surepip -vreturns a version above 3.x - if not usepip3 install -r requirements.txt) - Run the code with
python main.py(or withpython3 main.pyifpip -vreturned a version under 3.x)
Go to yourdomain.com/dashboard and you'll be redirected to your dashboard.
- A part of the code in tools/mailer.py was found at https://realpython.com/python-send-email/
- Thanks to the makers and contributers of FastAPI - without you this wouldn't have been possible. Check it out here: https://github.com/tiangolo/fastapi
- Thanks to lonaru for making EasyMDE (used as the Markdown Editor) Check it out here: https://github.com/Ionaru/easy-markdown-editor
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.