Skip to content

electro199/GoodMorningTech

 
 

Repository files navigation

Good Morning Tech


We are an open-source tech newsletter, sign up and stay updated with the latest news in tech at your convenience! Oh did I mention, we are 100% free?

Checkout our websiteGet in touch with usReport a bug

Project Details License Stars Contributors


Table of Content:
  1. Learn more about this project
  2. Get started
  3. What's planned ahead
  4. Frequently Asked Question's (FAQs)
  5. License
  6. Contact Us
  7. Our team

Learn more about this project

Mockup of the website

Built With

Figma Adobe Photoshop Dribbble
Python HTML5 CSS3 JavaScript
NPM Flask TailwindCSS
MongoDB Vercel Cybrancee

Features

  • Timezone Selection
  • Day and time Selection
  • Article Count Selection

Get started

Contribute

Contributing to this project is quite simple & straight forward. We'd request you to view our contributing file before getting started and follow our code of conduct.

Setting up on your local machine

Everything required to set this project up:

Cloning the repository

Clone the repository:

git clone https://github.com/GoodMorninTech/GoodMorningTech.git

Move into the new directory:

cd GoodMorningTech

Configuration

Create an instance folder:

mkdir instance

Move the configuration template into instance and rename it to config.py:

mv config.template.py instance/config.py

Edit the configuration file and make sure to set the following fields:

  • SECRET_KEY
  • MAIL_USERNAME
  • MAIL_PASSWORD
  • MAIL_DEFAULT_SENDER

Alternatively you can configure everything from environment variables, make sure to set all the variables in config.template.py.

Running the Server

Install the requirements:

pip install -r requirements.txt

Run the application:

python index.py

and in separate terminal run the tailwind compiler:

npm run tailwind

Set Up for Development

Install the development requirements:

pip install -r requirements-dev.txt
npm install

Install pre-commit hooks:

pre-commit install

What's Planned Ahead:

  • Time Selection
  • Timezone Selection
  • Addition of more news sources
  • Blogging System
  • Changelog System
  • Support for Other Languages
    • French
    • German
    • Spanish
  • Mobile App

Frequently Asked Question's (FAQs):

1. How does this work?

It gets the important posts from BBC, The Guardian, Verge & other credible sources and sends them to your email.

2. How do I subscribe?

Subscribing is as easy as heading to our sign up page and giving us your email & filling a small form (we promise we won't flood your inbox).

3. How do I unsubscribe?

We hate to see you leave, you can head to this page and enter your email ID, we'll then send you a link to verify your exit. Alternatively, each newsletter we send you has a footer with an unsubscribe link.

4. How do you guys fund your project if it's completely free?

We rely on donations/sponsors!

License

MIT

Contact Us

Twitter Instagram Discord

Our team

About

Get a daily dose of tech news in your mailbox!

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 66.1%
  • CSS 20.9%
  • Python 10.6%
  • JavaScript 2.4%