Skip to content

denboba/Hackitall2024

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

#🌍 **MyTribe App**

MyTribe is a social media application designed to connect people from the same country living abroad. Built with a **Flutter** frontend and a **Flask** backend, MyTribe fosters a sense of community among expatriates by providing a platform to share experiences, events, and support.

---
## πŸš€ **Features**

- **πŸ‘€ User Profiles**: Create and customize personal profiles to share information about yourself.
- **πŸ“ Community Posts**: Share updates, stories, and photos with the community.
- **πŸ“… Events**: Organize and discover events happening within your expatriate community.
- **πŸ’¬ Messaging**: Communicate directly with other users through private messages.
- **πŸ”” Notifications**: Stay informed about community activities and interactions.

---
## πŸ›  **Technologies Used**

- **Frontend**: πŸ–₯️ Flutter (**Dart**)
- **Backend**: 🐍 Flask (**Python**)
- **Database**: πŸ“‚ SQLite (for development)
- **APIs**: πŸ”— Integration with third-party services for authentication and data handling.

---
## πŸ“– **Getting Started**

### βœ… **Prerequisites**

Make sure you have the following installed:
- πŸ— **Flutter SDK**
- 🐍 **Python 3.x**
- πŸ“¦ **pip**

---
### πŸ“₯ **Installation**

#### **Clone the repository:**
 git clone https://github.com/denboba/Hackitall2024.git
 cd Hackitall2024


#### **Backend Setup:**
Navigate to the backend directory:
 cd backend


Create a virtual environment:

 python -m venv env


Activate the virtual environment:
- **On Windows:**

  .\env\Scripts\activate

- **On macOS/Linux:**

  source env/bin/activate


Install the required packages:
 pip install -r requirements.txt


Initialize the database:

 flask db init
 flask db migrate -m "Initial migration."
 flask db upgrade


Run the Flask application:

 flask run


#### **Frontend Setup:**
Navigate to the frontend directory:
 cd ../frontend


Get the Flutter dependencies:
 flutter pub get


Run the Flutter application:
 flutter run


---
## 🀝 **Contributing**

We welcome contributions to enhance **MyTribe**. To contribute:

1. **Fork** the repository.
2. **Create a new branch:**
   git checkout -b feature/YourFeatureName

3. **Commit your changes:**
   git commit -m "Add your feature."

4. **Push to the branch:**
   git push origin feature/YourFeatureName
 
5. **Open a Pull Request.**


## πŸ“œ **License**

This project is licensed under the **MIT License**. See the `LICENSE` file for details.

--- 
πŸŽ‰ Happy coding! πŸš€

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published