diff --git a/README.md b/README.md index d7f89f2..80f1857 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ This Flutter application helps entrepreneurs find the right co-founders who comp - **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. +- **Dark Mode Support**: Toggle between a light and a dark theme for a personalized app experience. ## Screenshots @@ -16,6 +17,7 @@ This Flutter application helps entrepreneurs find the right co-founders who comp ![Matching screen: Swipe right](lib/assets/screenshots/swipe_right.png) ![User profile](lib/assets/screenshots/user_info.png) ![Chat](lib/assets/screenshots/chat.png) +![Chat darkmode](lib/assets/screenshots/chat_dark.png) ## Getting Started @@ -54,13 +56,83 @@ This Flutter application helps entrepreneurs find the right co-founders who comp - **utils/**: Utility classes and functions. - **main.dart**: Entry point of the application. +## Technical Information + +### Dependencies + +This project uses the following external packages: + - [expandable_text](https://pub.dev/packages/expandable_text): Widget that only shows the first lines of a text and adds a link to expand the full text. + - [flutter_svg](https://pub.dev/packages/flutter_svg): An SVG rendering and widget library for Flutter, which allows painting and displaying Scalable Vector Graphics 1.1 files. + - [geocoding](https://pub.dev/packages/geocoding): A Flutter Geocoding plugin which provides easy geocoding and reverse-geocoding features. + - [geolocator](https://pub.dev/packages/geolocator): Flutter geolocation plugin which provides easy access to platform specific location services. + - [image_cropper](https://pub.dev/packages/image_cropper): A Flutter plugin for cropping images. + - [image_picker](https://pub.dev/packages/image_picker): Flutter plugin for selecting images from the Android and iOS image library, and taking new pictures with the camera. + - [osm_nominatim](https://pub.dev/packages/osm_nominatim): A library to perform OSM Nominatim searches also supporting reverse searches. + - [percent_indicator](https://pub.dev/packages/percent_indicator): Library that allows you to display progress widgets based on percentage, can be Circular or Linear, you can also customize it to your needs. + - [shared_preferences](https://pub.dev/packages/shared_preferences): Flutter plugin for reading and writing simple key-value pairs. + - [swipable_stack](https://pub.dev/packages/swipable_stack): A widget for stacking cards, which users can swipe horizontally and vertically with beautiful animations like Tinder. + +Using [**Firebase**](https://firebase.google.com/) as the backend platform, this project also uses the following plugins: + - [cloud_firestore](https://pub.dev/packages/cloud_firestore): Flutter plugin for Cloud Firestore, a cloud-hosted, noSQL database. + - [firebase_auth](https://pub.dev/packages/firebase_auth): Flutter plugin for Firebase Auth, enabling authentication. + - [firebase_core](https://pub.dev/packages/firebase_core): Flutter plugin for Firebase Core, enabling connecting to multiple Firebase apps. + - [firebase_storage](https://pub.dev/packages/firebase_storage): Flutter plugin for Firebase Cloud Storage, a simple object storage service. + +In addition to the above, this project also uses the following **optional** packages: + - [flutter_launcher_icons](https://pub.dev/packages/flutter_launcher_icons): A package which simplifies the task of updating your Flutter app's launcher icon. + + ### 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. It might work on iOS without any changes, but this has not been confirmed. + +## Using the App + +Due to the nature of this project, an **online connection is required**. + +1. Register or Login + +2. Fill out your profile information +- Setting your location works best using the Current Position feature. This feature requires temporary access to the device's GPS services. +- You can also enter a location manually by searching either by textual location or by coordinates. + Here are three examples of what the input text could look like: + ```bash + Heidelberg + Mannheim Glücksteinallee + 76133 Karlsruhe + ``` + + The input format to search by coordinates is ```Latitude, Longitude```. Here are two examples of how to input the coordinates: + ```bash + 49.46997, 8.482 + -19.03, -65.25 + ``` + + The search results may not always be very accurate. If no results are found for your search input, please check your input or try a different search term. + +3. Swipe through user profiles +- In the profile overview, you can swipe other users' profiles to the right (like), left (dislike), or up (skip, to decide later). + +4. Connect with your matches through chat. +- Once you match with other users, you can chat with them to get to know each other better or exchange personal information. + +## Android Binary + +To quickly get started on Android, you can directly download the current APK file of this app from [here](https://clousi.hs-mannheim.de/index.php/s/nB9dncgybpBBroZ). +Since the binary is unsigned, it is highly recommended to verify its integrity by comparing the checksum before installing it on your device. + +### Checksums + +Filename : **cofounderella-v1.0.1-240619.apk** +- MD5 : ```46f044271604b8a8a9efe2cea57098be``` +- SHA-1 : ```31038f61da955c5305157e8391b2ed327a2d8222``` +- SHA-256 : ```f9be2f14238ddc2a53f5cd8c0f76f9ad8e248395b4cc2d494a4c22b70b1404d6``` +- SHA-512 : ```bbc95ad98921905de51d5f22d65bd6d7ffb8ddd4bae2c2e263a6ee72589f0dc86b51998c26efe36996fc17d17ff1ec6924f1ef325e6b6a2a48f279733e5a58d5``` + + -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 diff --git a/lib/assets/screenshots/chat_dark.png b/lib/assets/screenshots/chat_dark.png new file mode 100644 index 0000000..f4ff162 Binary files /dev/null and b/lib/assets/screenshots/chat_dark.png differ