Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/faizanxmulla/flask-blog-app-v2
A web application where users can register, login, create and manage posts, comment on other users' posts, follow and unfollow other users, and search for other users. Additional features include : Backend jobs like export, alert and reporting jobs.
https://github.com/faizanxmulla/flask-blog-app-v2
backend caching celery flask frontend full-stack redis sqlite vuejs webdevelopment
Last synced: about 1 month ago
JSON representation
A web application where users can register, login, create and manage posts, comment on other users' posts, follow and unfollow other users, and search for other users. Additional features include : Backend jobs like export, alert and reporting jobs.
- Host: GitHub
- URL: https://github.com/faizanxmulla/flask-blog-app-v2
- Owner: faizanxmulla
- License: mit
- Created: 2023-06-08T14:31:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-06T18:09:39.000Z (about 1 year ago)
- Last Synced: 2024-08-13T07:18:28.438Z (5 months ago)
- Topics: backend, caching, celery, flask, frontend, full-stack, redis, sqlite, vuejs, webdevelopment
- Language: Vue
- Homepage: https://flask-blog-app-v2.vercel.app
- Size: 8.68 MB
- Stars: 15
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - faizanxmulla/flask-blog-app-v2 - A web application where users can register, login, create and manage posts, comment on other users' posts, follow and unfollow other users, and search for other users. Additional features include : Ba (Vue)
README
# Flask Blog-App V2
[](https://opensource.org/licenses/MIT)
A modern, high-performance social media platform built with Flask and Vue.js, featuring real-time updates, asynchronous processing, and intelligent caching.
## 🚀 Features
### Core Functionality
- **Robust Authentication** - Secure JWT-based user authentication system
- **Content Management**
- Create, edit, and delete posts with images
- Rich text support with safe HTML handling
- **Social Networking**
- Follow/unfollow system
- Personalized feed based on followed users
- User search functionality
- **Interaction**
- Comment on posts
- User profiles with engagement metrics
### Advanced Features
- **Asynchronous Processing**
- CSV export of user data
- Monthly engagement reports (HTML/PDF)
- Daily activity reminders
- **Performance Optimization**
- Redis-based caching with intelligent expiry
- Batch processing for heavy operations
## 🛠 Technology Stack
- **Backend**: Flask (Python 3.7+)
- **Frontend**: Vue.js with CLI
- **Database**: SQLite with SQLAlchemy ORM
- **Caching**: Redis
- **Task Queue**: Celery
- **UI Framework**: Bootstrap
- **Template Engine**: Jinja2 (for emails)
## 📋 Prerequisites
- Python 3.7 or higher
- Node.js 14.x or higher
- Redis server
- MailHog (for local email testing)
## 🔧 Installation & Setup
1. **Clone the repository**
```bash
git clone https://github.com/faizanxmulla/flask-blog-app-v2.git
cd flask-blog-app-v2
```
2. **Set up the backend**
```bash
cd backend
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
pip install -r requirements.txt
```
3. **Set up the frontend**
```bash
cd frontend
npm install
```
4. **Start required services**
```bash
# Terminal 1
redis-server
# Terminal 2
mailhog
```
## 🚦 Running the Application
1. **Start the backend services**
```bash
# Terminal 1 - API Server
cd backend
python main.py
# Terminal 2 - Celery Worker
cd backend
celery -A main.celery worker -l info
# Terminal 3 - Celery Beat
cd backend
celery -A main.celery beat --max-interval 1 -l info
```
2. **Start the frontend development server**
```bash
cd frontend
npm run serve
```
The application will be available at http://localhost:8080
## 🏗 Architecture
### Database Schema
- **User**: Stores user data, authentication info, and social metrics
- **Post**: Contains post content, metadata, and relationships
- **Comment**: Manages user interactions on posts
- **Follow**: Handles user-to-user relationships
### API Design
RESTful architecture with the following main endpoints:
- Authentication: `/api/register`, `/api/login`, `/api/token/refresh`
- Posts: `/api/post`, `/api/post/`
- Feed: `/api/feed`
- User: `/api/user`, `/api/profile/`
- Social: `/api/follow/`, `/api/unfollow/`
## 🤝 Contributing
We welcome contributions! Please follow the steps below:
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/newFeature`)
3. Commit your changes (`git commit -m 'Add some newFeature'`)
4. Push to the branch (`git push origin feature/newFeature`)
5. Open a Pull Request
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 👏 Acknowledgments
- Inspired by modern social media platforms
- Built as part of the Modern Application Development - II course (Course ID: `BSCS2006`)
## ⭐ Support my work
Do ⭐ the repository, if it inspired you, gave you ideas for your own project or helped you in any way !!!