https://github.com/akash-nath29/buzzhub
A flask based application to share your thoughts with your friends
https://github.com/akash-nath29/buzzhub
Last synced: 29 days ago
JSON representation
A flask based application to share your thoughts with your friends
- Host: GitHub
- URL: https://github.com/akash-nath29/buzzhub
- Owner: Akash-nath29
- License: apache-2.0
- Created: 2023-06-11T12:40:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-11T12:56:57.000Z (almost 2 years ago)
- Last Synced: 2025-02-12T11:53:41.589Z (3 months ago)
- Language: CSS
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BuzzHub
A flask based application to share your thoughts with your friends
A Colorful and Engaging Flask-based Web Application for Sharing Your Thoughts!
## 🚀 Introduction
Welcome to BuzzHub, a vibrant and user-friendly web application built with Flask. BuzzHub allows you to share your thoughts by writing captivating posts, while enabling other users to view and interact with them. With BuzzHub, you can create your own unique username, explore exciting posts from fellow users, like their posts, and engage in meaningful discussions by leaving comments.
## 🔥 Key Features
- **User Registration:** Create your personalized username and password to access BuzzHub's exciting features.
- **Post Creation:** Share your thoughts, ideas, or stories by creating captivating posts.
- **Post Viewing:** Explore a visually appealing feed of posts created by other talented users.
- **Post Interactions:** Engage with the community by liking and leaving comments on posts that inspire you.
- **User Profile:** Customize your profile page, showcasing your posts and activity to fellow BuzzHub users.
- **User Authentication:** Experience secure authentication and authorization to safeguard your BuzzHub account.
## 🛠️ Installation
Follow these steps to set up BuzzHub locally on your machine:
1. **Clone the repository:**
```bash
git clone https://github.com/Akash-nath29/BuzzHub.git
```
2. **Navigate to the project directory:**
```bash
cd BuzzHub
```
3. **Create a virtual environment (optional but recommended):**
```bash
python3 -m venv env
```
4. **Activate the virtual environment:**
On macOS and Linux:
```bash
source env/bin/activate
```
On Windows:
```bash
env\Scripts\activate
```
5. **Install the required dependencies:**
```bash
pip install -r requirements.txt
```
6. **Set up the database:**
```bash
flask db init
flask db migrate
flask db upgrade
```
7. **Run the application:**
```bash
flask run
```
BuzzHub is now up and running locally at [http://localhost:5000](http://localhost:5000).
## 🌟 Usage
- Visit the BuzzHub homepage to create a new account or log in with your existing credentials.
- Once logged in, unleash your creativity by clicking the "New Post" button to create a captivating post.
- Immerse yourself in the vibrant BuzzHub community by exploring posts from other users displayed in the engaging feed.
- Show appreciation for remarkable posts by clicking the heart-shaped button to like them.
- Join stimulating conversations by scrolling to the bottom of a post and leaving your thoughts in the comment section.
- Refine your search for specific posts or users by utilizing the powerful search bar located at the top of the page.
## 🤝 Contributing
We welcome and appreciate contributions to BuzzHub! If you find
a bug or have suggestions for new features, please open an issue in the [issue tracker](https://github.com/Akash-nath29/BuzzHub/issues). If you would like to contribute code, kindly fork the repository, make your changes, and submit a pull request.
Please ensure that your code adheres to the existing coding style and conventions. Additionally, remember to include tests for any new functionality you introduce.
## 📝 License
The BuzzHub project is licensed under the [MIT License](LICENSE).
## 🙏 Acknowledgements
We extend our gratitude to the following technologies and libraries that made BuzzHub possible:
- [Flask](https://flask.palletsprojects.com/): A micro web framework for Python.
- [Font Awesome](https://fontawesome.com/): A library of icons for use in web applications.
Enjoy sharing your thoughts and engaging with the BuzzHub community! 🐝✨