Square Ghost

Description

A simple CRUD app that uses Firebase Authentication and Firebase Realtime Database.

Responsibilities

• User authentication with Firebase Authentication
• Data storage in Firebase Realtime Database
• CRUD operations on user profiles

Square Ghost UI

Video demonstration of Square Ghost

Getting Started

Prerequisites

Ensure Flutter is installed on your machine. For installation instructions, refer to the official Flutter website.

Installation

Follow these steps to run the Square Ghost Application:

1. Clone this repository to your local machine:

git clone https://github.com/muj-i/square_ghost.git

2. Navigate to the project folder:

cd square_ghost

3. Install dependencies:

flutter pub get

How to Run

Connect your device or emulator and run the app using the following command:

flutter run

Used Packages

Square Ghost integrates the following packages to enhance functionality:

• firebase_core: ^2.15.0: Firebase Core for Firebase integration.
• firebase_auth: ^4.7.1: Firebase Authentication for user authentication.
• google_fonts: ^5.1.0: Access Google Fonts for typography options.
• font_awesome_flutter: ^10.5.0: Access a wide range of Font Awesome icons for stylish visuals.
• firebase_database: ^10.2.4: Firebase Realtime Database for real-time data storage.
• flutter_launcher_icons: ^0.13.1: Simplify the generation of launcher icons on various platforms.
• firebase_crashlytics: ^3.3.5: Firebase Crashlytics for crash reporting and analysis.

Project Directory Structure

The Square Ghost directory structure is organized as follows:

  progress_pal/
  ├── assets/
  │   ├── logo/
  │   │   ├── logo_name.png
  │   │   ├── logo.png
  │   │   ├── logo2.png
  ├── lib/
  │   ├── pages/
  │   │   ├── auth_pages/
  │   │   │   ├── forgot_password_page.dart
  │   │   │   ├── logedin_checking_page.dart
  │   │   │   ├── login_page.dart
  │   │   │   ├── signup_page.dart
  │   │   ├── home_page.dart
  │   │   ├── update_user_data_page.dart
  │   ├── reusable_widgets/
  │   │   ├── all_over_button.dart
  │   │   ├── constants.dart
  │   │   ├── delete_account.dart
  │   │   ├── gender_selection.dart
  │   │   ├── log_in_sign_up_button.dart
  │   │   ├── selected_gender.dart
  │   ├── firebase_options.dart
  │   ├── main.dart

Contributors

• Mujahedul Islam

Special Thanks

A heartfelt thanks to Mitch Koko for his enlightening tutorial on Firebase & for teaching me how to make UI like this.

The Firebase tutorial of Mitch I follow:

Firebase x Flutter Tutorial

Email Login & Logout • Flutter Auth Tutorial ♡

License

This project is licensed under the MIT License. Refer to the LICENSE file for details.