https://github.com/2kabhishek/byteblog

A minimalist microblogging platform 🐦🔇
https://github.com/2kabhishek/byteblog

flask flask-login flask-migrate flask-sqlalchemy microblogging-service python rest-api

Last synced: 3 days ago
JSON representation

A minimalist microblogging platform 🐦🔇

• Host: GitHub
• URL: https://github.com/2kabhishek/byteblog
• Owner: 2KAbhishek
• License: gpl-3.0
• Created: 2020-01-18T04:53:44.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T17:35:04.000Z (19 days ago)
• Last Synced: 2024-10-27T20:50:57.144Z (19 days ago)
• Topics: flask, flask-login, flask-migrate, flask-sqlalchemy, microblogging-service, python, rest-api
• Language: Python
• Homepage: http://172.105.38.52
• Size: 225 KB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


Byteblog




 



 







 



 



 






  



Byteblog is a minimalist micro-blogging platform built with Pyhton Flask for anyone seeking a quieter "Social Media".

A user can easily register for Byteblog with their email id and password and then can easily share their bytes (similar to tweets in twitter) and also follow other people to read their thoughts, users can also message other users who follow them.

## Features

- Posts

- Follow/Unfollow Users

- Messages

- Notifications

It was created to learn about various concepts of web application development including concepts like authentication, localization, deployments, testing, REST API building etc.

## Technologies Used

- Python Flask

- SQL Alchemy

- Bootstrap

- WTForms

- Moment.js

- More including various flask plugins

### Technical Features

Here are a few technical highlights of Byteblog.

- Modular Design:

  Built with Flask Blueprint to promote code reusability and modular design, parts of this project can be integrated into other projects without much changes.

- Universal Database Support:

  Uses SQL Alchemy for database interactions and can work with any database.

- Migrate Database:

  Built with Flask Migrate to aid in database migrations, a database migration can be done with one simple command `flask db upgrade`.

- Universal Deployment:

  Byteblog comes with all the configurations so that it can be deployed locally, on Docker, on VirtualBox and Heroku.

- Ephemeral Database:

  Byteblog's production deployment on Heroku uses an ephemeral database which guarantees user data security and privacy.

- REST API Support:

  Byteblog has JSON API support added to it so developers can add new API routes and build apps for any platform they wish.

- Testing Support:

  Byteblog has testing support added to it so that changes can be verified before deploying to production, new tests can be added easily too.

## Dev Setup

```bash

git clone https://github.com/2kabhishek/Byteblog

cd Byteblog

pip install virtualenv

virtualenv env

source env/bin/activate

pip install -r ./requirements/development.txt

flask db upgrade

flask run

```