The FashionFinder Flutter App is a mobile application that helps users find and explore fashion stores, products, and branches with seamless geolocation functionality. Built with Flutter, this app is designed for both Android and iOS platforms, providing a user-friendly interface and robust performance.
- Becerra Díaz Alejandro
- González Hernández Juan Pablo
- Núñez Guerrero Melanie Guadalupe
- Peña Bravo María Cecilia
- Trujillo Ramírez César Andrés
Frausto Ramírez Juan de Dios
11/12/2024
Software Engineering and Computational Systems - 712
- Features
- Getting Started
- Prerequisites
- Installation
- Environment Configuration
- Folder Structure
- Usage
- Screens
- Technologies
- Contributing
- License
- User Authentication: Login and register functionality.
- Search and Filtering: Find stores, products, and branches using dynamic search and category filters.
- Geolocation Integration: Display branches on a map, with user location tracking.
- Responsive Design: Optimized for both Android and iOS devices.
- Interactive UI: Navigate through stores, categories, and products with a clean and intuitive design.
Follow these instructions to set up the project on your local machine for development and testing.
- Flutter SDK: Install Flutter (version >= 3.0.0).
- Dart SDK: Comes with Flutter installation.
- Code Editor: VS Code (recommended) or Android Studio.
- Device Emulator: Android Emulator or iOS Simulator.
-
Clone the repository:
git clone https://github.com/Pavlitoh/FashionFinder.git cd FashionFinder/flutter_app -
Install dependencies:
flutter pub get
-
Run the app:
- For Android:
flutter run
- For iOS:
flutter run --release
- For Android:
The app uses environment variables for API endpoints and third-party services. Create a .env file in the lib/config directory:
# API Configuration
API_BASE_URL=https://fashionfinder.ddns.net/api
# Geolocation API Keys
GOOGLE_MAPS_API_KEY=your_google_maps_api_keyReplace your_google_maps_api_key with your actual Google Maps API Key.
The project follows a feature-based structure:
lib/
│
├── config/ # Environment variables and app-wide configuration
├── models/ # Data models for stores, products, branches, etc.
├── services/ # API service layer
├── providers/ # State management (e.g., Riverpod or Provider)
├── screens/ # UI screens for login, home, search, and more
├── widgets/ # Reusable UI components
├── utils/ # Helper functions and utilities
├── main.dart # App entry point
- Launch the app on an emulator or physical device.
- Explore the following key features:
- Login/Register: Access your account or create a new one.
- Search: Filter stores and products by categories.
- Map View: Locate branches on a map using GPS.
- Product Details: View detailed descriptions of products.
The app includes the following screens:
-
Register and Login Screen: User authentication for clients and admins.
-
Home Screen: Display of featured stores, categories, and products.
-
Category Filter and CRUD: Explore stores and products by category with CRUD for admin.
-
Store Details, CRUD, and Locator: Map view showing branches and user location with CRUD for admin.
-
Product list, details and CRUD: In-depth view of individual product details with CRUD for admin.
The FashionFinder Flutter App uses the following technologies:
- Flutter: Framework for building natively compiled applications for mobile.
- Dart: Programming language used for Flutter.
- Google Maps API: For geolocation and branch mapping.
- Firebase: For analytics and push notifications (if configured).
- REST APIs: Backend integration for dynamic data.
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
- Commit your changes:
git commit -m "Add your feature description" - Push to the branch:
git push origin feature/your-feature-name
- Submit a pull request.