Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Icon change #3

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 45 additions & 44 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,44 +1,45 @@
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
migrate_working_dir/

# IntelliJ related
*.iml
*.ipr
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
.packages
.pub-cache/
.pub/
/build/

# Symbolication related
app.*.symbols

# Obfuscation related
app.*.map.json

# Android Studio will place build artifacts here
/android/app/debug
/android/app/profile
/android/app/release
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
migrate_working_dir/

# IntelliJ related
*.iml
*.ipr
*.iws
.idea/
android/app/src/google-services.json
# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
.packages
.pub-cache/
.pub/
/build/
android/app/google-services.json

# Symbolication related
app.*.symbols

# Obfuscation related
app.*.map.json

# Android Studio will place build artifacts here
/android/app/debug
/android/app/profile
/android/app/release
90 changes: 45 additions & 45 deletions .metadata
Original file line number Diff line number Diff line change
@@ -1,45 +1,45 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled.

version:
revision: 796c8ef79279f9c774545b3771238c3098dbefab
channel: stable

project_type: app

# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: android
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: ios
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: linux
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: macos
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: web
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: windows
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab

# User provided section

# List of Local paths (relative to this file) that should be
# ignored by the migrate tool.
#
# Files that are not part of the templates will be ignored by default.
unmanaged_files:
- 'lib/main.dart'
- 'ios/Runner.xcodeproj/project.pbxproj'
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled.
version:
revision: 796c8ef79279f9c774545b3771238c3098dbefab
channel: stable
project_type: app
# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: android
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: ios
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: linux
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: macos
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: web
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
- platform: windows
create_revision: 796c8ef79279f9c774545b3771238c3098dbefab
base_revision: 796c8ef79279f9c774545b3771238c3098dbefab
# User provided section
# List of Local paths (relative to this file) that should be
# ignored by the migrate tool.
#
# Files that are not part of the templates will be ignored by default.
unmanaged_files:
- 'lib/main.dart'
- 'ios/Runner.xcodeproj/project.pbxproj'
31 changes: 31 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Flutter: Attach to Device",
"type": "dart",
"request": "attach"
},

{
"name": "retrieve_me",
"request": "launch",
"type": "dart"
},
{
"name": "retrieve_me (profile mode)",
"request": "launch",
"type": "dart",
"flutterMode": "profile"
},
{
"name": "retrieve_me (release mode)",
"request": "launch",
"type": "dart",
"flutterMode": "release"
}
]
}
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"cmake.configureOnOpen": false
}
178 changes: 96 additions & 82 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,96 @@
# Setup Guide for "Retrieve Me" Project

Welcome to the setup guide for the "Retrieve Me" project, a Flutter and Firebase-based application developed using Agile methodologies. In this guide, we will walk you through the process of setting up the project on your local machine for development and testing purposes.

## Prerequisites

Before you begin, make sure you have the following prerequisites installed on your system:

1. **Git**: Version control system for cloning the project repository.
2. **Flutter**: SDK for building native applications using the Dart programming language.
3. **Firebase Account**: Access to Firebase console for project configuration.
4. **Android Studio** or **VS Code**: Integrated development environment (IDE) for Flutter development.
5. **Android/iOS Emulator** or a physical device for testing.

## Step-by-Step Setup Process

Follow these steps to set up the "Retrieve Me" project on your local machine:

### 1. Clone the Repository

Open a terminal and execute the following command to clone the project repository:

```bash
git clone https://github.com/Md-Kais/retrieve_me.git
```

### 2. Set Up Firebase

1. User have to provide me his EMAIL to access the firebase database.

### 3. Install Dependencies

Navigate to the project directory and install the required dependencies using the following command:

```bash
cd retrieve_me
flutter pub get
```

### 4. Run the Application

Use your preferred IDE (Android Studio or VS Code) to open the project directory.

#### Running on Android Emulator/Device

1. Ensure your Android emulator or physical device is connected.
2. Run the app using the IDE's run button or execute the following command in the terminal:

```bash
flutter run
```

#### Running on iOS Simulator/Device

1. Ensure you have Xcode installed on macOS.
2. Open the `ios/Runner.xcworkspace` file in Xcode.
3. Select your desired simulator or device.
4. Click the run button or use the following command:

```bash
flutter run
```

### 5. Testing

You can now interact with the "Retrieve Me" app on the emulator or device. Explore its features and functionalities to ensure everything is working as expected.

## Contributing and Agile Workflow

If you're interested in contributing to the project, we follow an Agile development workflow using Git. Create a new branch for your feature or bug fix, make your changes, and submit a pull request to the `develop` branch.

For Agile-related tasks, we use tools like Trello to manage user stories, tasks, and sprints. Feel free to join our Agile boards and participate in the development process.

## Conclusion

Congratulations! You've successfully set up the "Retrieve Me" project on your local machine using Agile development practices. You can now start developing, testing, and contributing to the project. If you encounter any issues, refer to the project documentation or reach out to the development team for assistance.

Happy coding! 🚀

## Team Members:
1. Imran Farid
2. Ramisa Zahara Matin
# <h1 align = "center"> RETRIEVE ME </h1>

## Table of Contents
- [Overview](#overview)
- [Seteup Guide](#steup-guide)
- [Installation](#installation)
- [Features](#features)
- [Getting Started](#getting-started)
- [Acknowledgements](#acknowledgements)
- [Contributors](#contributors)

## Overview


## Setup Guide

Welcome to the setup guide for the "Retrieve Me" project, a Flutter and Firebase-based application developed using Agile methodologies. In this guide, we will walk you through the process of setting up the project on your local machine for development and testing purposes.

### Prerequisites

Before you begin, make sure you have the following prerequisites installed on your system:

1. **Git**: Version control system for cloning the project repository.
2. **Flutter**: SDK for building native applications using the Dart programming language.
3. **Firebase Account**: Access to Firebase console for project configuration.
4. **Android Studio** or **VS Code**: Integrated development environment (IDE) for Flutter development.
5. **Android/iOS Emulator** or a physical device for testing.

### Step-by-Step Setup Process

Follow these steps to set up the "Retrieve Me" project on your local machine:

#### 1. Clone the Repository

Open a terminal and execute the following command to clone the project repository:

```bash
git clone https://github.com/Md-Kais/retrieve_me.git
```

### 2. Set Up Firebase

1. User have to provide me his EMAIL to access the firebase database.

### 3. Install Dependencies

Navigate to the project directory and install the required dependencies using the following command:

```bash
cd retrieve_me
flutter pub get
```

#### 4. Run the Application

Use your preferred IDE (Android Studio or VS Code) to open the project directory.

##### Running on Android Emulator/Device

1. Ensure your Android emulator or physical device is connected.
2. Run the app using the IDE's run button or execute the following command in the terminal:

```bash
flutter run
```

##### Running on iOS Simulator/Device

1. Ensure you have Xcode installed on macOS.
2. Open the `ios/Runner.xcworkspace` file in Xcode.
3. Select your desired simulator or device.
4. Click the run button or use the following command:

```bash
flutter run
```

#### 5. Testing

You can now interact with the "Retrieve Me" app on the emulator or device. Explore its features and functionalities to ensure everything is working as expected.

### Contributing and Agile Workflow

If you're interested in contributing to the project, we follow an Agile development workflow using Git. Create a new branch for your feature or bug fix, make your changes, and submit a pull request to the `develop` branch.

For Agile-related tasks, we use tools like Trello to manage user stories, tasks, and sprints. Feel free to join our Agile boards and participate in the development process.

### Conclusion

Congratulations! You've successfully set up the "Retrieve Me" project on your local machine using Agile development practices. You can now start developing, testing, and contributing to the project. If you encounter any issues, refer to the project documentation or reach out to the development team for assistance.

Happy coding! 🚀

## Contributors:
1. Imran Farid
2. Ramisa Zahara Matin
Loading