ultasun/microblog repository overview

⁠Miguel Grinberg's Mega Flask Tutorial

Miguel Grinberg had wrote an excellent tutorial series⁠ on developing a full stack web application system using the Flask⁠ framework.

His system has the reader utilize much more, including Elasticsearch⁠, Redis⁠, RQ⁠ and SQLAlchemy⁠.

The system is called Microblog.

⁠Improvements from the original Microblog

The maintainer of this repository⁠ had expanded on Miguel's excellent work:

1. This Microblog⁠ will use LibreTranslate⁠ to provide translation services to users.
   • This Microblog has all translation queries served internally.
   • Miguel's original tutorial has the reader use an external translation API⁠
2. This Microblog provides a stand-alone docker-compose.yml⁠, which allows for easy deployment of the full stack system.
   • The only other file needed by users to bring up Microblog is a configuration file⁠.

⁠Installation

1. Install Docker⁠, Docker Desktop⁠ or Podman⁠,
2. Download docker-compose.yml⁠,
3. Download .env.example⁠,
   • Rename it to .env, and then,
   • Place it into the same directory as docker-compose.yml,
4. Using a terminal, cd to the directory containing both docker-compose.yml and .env, and run:
   • docker compose up
5. Wait about 15 minutes (or longer) for:
   • All images to download (the LibreTranslate image is large),
   • After the LibreTranslate container starts, it takes about 10 more minutes before it will begin serving translation requests,
6. Using a web browser, access the service on standard HTTP port 80!
   • For example, http://localhost/⁠

⁠More information

There is an original README.old.md⁠ which was used by the maintainer of this repository while following Miguel's tutorial. That README.old.md⁠ has notes which, ultimately, have been translated into the run.sh⁠, Dockerfile⁠, docker-compose.yml⁠, and more.

⁠Credits

This image is built from commit a6c0b1cd30e82827133204aaee7be514435c3314 of this repository⁠.

The original tutorial was written by Miguel Grinberg⁠. All the code in this repository was physically typed on a keyboard by ultasun⁠ while following Miguel's tutorial.

Thanks Miguel! Thank you for reading.