Skip to content

Technical Installation Manual

Jump to bottom
Monika Theiss edited this page Oct 18, 2024 · 7 revisions

Install as User

Introduction:

Welcome to GameOnConnect, a social media platform for gamers, designed exclusively for Android devices. Built using Flutter with Firebase as the backend, GameOnConnect efficiently handles user data and images, ensuring a seamless gaming experience. All user data is securely stored in Firebase and is retrieved as needed to enhance performance and scalability.

Prerequisites:

  • Android Device: GameOnConnect is specifically developed for Android, so an Android device is required to use the app.
  • No Additional Hardware/Software: The app includes all necessary packages, so no additional hardware or software is needed.

Installation:

  1. Download the APK: To install GameOnConnect, download the APK file using the following link: GameOnConnect and download the top apk file.
  2. Enable Installations from Unknown Sources:
  • Go to Settings > Security.
  • Enable Install unknown apps or Unknown sources (This setting may vary depending on your Android version).
  1. Install the APK: Open the downloaded APK file and follow the on-screen prompts to install GameOnConnect on your device.

Deployment/Running:

Install as Developer

Introduction:

Welcome to the GameOnConnect development setup guide. This manual will walk you through the steps required to set up your development environment using Visual Studio Code (VS Code), clone the repository, and run the project in your browser. GameOnConnect is built using Flutter for the front-end and Firebase for the back-end, so having the correct software and tools installed is essential.

Prerequisites:

1. Install Flutter:

  • Flutter SDK: Download and install the Flutter SDK from the official Flutter website.
  • Ensure that the Flutter installation directory is added to your system’s PATH.
  • Verify the installation by running the following command in your terminal or command prompt: flutter doctor
  • Address any issues reported by flutter doctor.

2. Install Visual Studio Code:

  • Visual Studio Code (VS Code): Download and install VS Code from the official website.
  • Install the Flutter and Dart extensions from the VS Code marketplace.

3. Set Up a Web Environment:

  • Chrome or Edge Browser: Ensure that you have the latest version of Chrome or Edge installed, as Flutter supports running apps in these browsers.

4. Firebase Setup:

  • Firebase Project: Ensure you have access to the Firebase project used by GameOnConnect. Obtain the necessary Firebase configurations, such as the firebase_options.dart file, and set them up in your project.
  • If required, install the Firebase CLI: npm install -g firebase-tools

Cloning the Repository:

  • Clone the GameOnConnect Repository: git clone https://github.com/COS301-SE-2024/GameOnConnect.git
  • Navigate to the Project Directory: cd GameOnConnect

Running the Project in the Browser:

1. Install Dependencies:

  • Open the project directory in VS Code.
  • Open the terminal in VS Code (Ctrl + ) and run: flutter pub get

2. Configure Firebase:

  • Ensure the Firebase configuration (such as the firebase_options.dart file) is correctly set up in your project.

3. Run the App in the Browser:

  • Start the app using: flutter run
  • This will open the app in the selected browser.
Byte Squad logo

Clone this wiki locally