Replaced default README.md

README.md

@@ -1,16 +1,69 @@
-# cofounderella
+# Cofounderella
 
-App for Cofounder Matching
+This Flutter application helps entrepreneurs find the right co-founders who complement their skills and also share their interests and business goals. Whether you are looking for a tech expert, a marketing guru, or a visionary partner. This app aims to help you finding a perfect co-founder to bring your startup ideas to life.
+
+## Features
+
+- **Matchmaking:** Swipe through potential co-founders inorder to find a match.
+- **View profiles:** Browse through all your swiped or matched profiles.
+- **Chat:** In-app messaging to communicate with potential co-founders and discuss your ideas and vision without revealing personal contact details.
+- **Profile Creation:** Create and update your profile to present yourself attractively to others.
+
+## Screenshots
+
+![Home screen](lib/assets/screenshots/home.png)
+![Matching screen: Swipe left](lib/assets/screenshots/swipe_left.png)
+![Matching screen: Swipe right](lib/assets/screenshots/swipe_right.png)
+![User profile](lib/assets/screenshots/user_info.png)
+![Chat](lib/assets/screenshots/chat.png)
 
 ## Getting Started
 
-This project is a starting point for a Flutter application.
+### Prerequisites
 
-A few resources to get you started if this is your first Flutter project:
+- [Flutter SDK](https://flutter.dev/docs/get-started/install)
+- [Android Studio](https://developer.android.com/studio) or [Xcode](https://developer.apple.com/xcode/) (for iOS development)
+- A code editor like [VS Code](https://code.visualstudio.com/) or Android Studio
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+### Installation
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+1. **Clone the repository**
+
+2. **Install dependencies:**
+
+   ```bash
+   flutter pub get
+   ```
+
+3. **Run the app:**
+
+   ```bash
+   flutter run
+   ```
+
+### Folder Structure
+
+- **lib/**: Contains the main code for the application.
+    - **assets/**: Icons and other assets.
+    - **components/**: Reusable widgets.
+    - **forms/**: UI forms.
+    - **models/**: Data models.
+    - **pages/**: UI screens.
+    - **services/**: Backend and API services.
+    - **themes/**: Theme provider.
+    - **utils/**: Utility classes and functions.
+    - **main.dart**: Entry point of the application.
+
+### Supported Platforms
+
+This project was developed on Windows using Flutter version 3.22.1 and Dart version 3.4.1.
+It has been tested and is operational on both **Android** and **Web** platforms.
+
+Other platforms, such as iOS, have not yet been tested.
+Therefore, it might work on iOS without any changes, but this has not been confirmed.
+
+## Contact
+
+If you have any questions or suggestions, feel free to reach out to me at [1024481@stud.hs-mannheim.de](mailto:1024481@stud.hs-mannheim.de).
+
+Happy matching!