Skip to content

Latest commit

 

History

History
115 lines (74 loc) · 4.02 KB

setup.md

File metadata and controls

115 lines (74 loc) · 4.02 KB

Step 1) 🖥️ How to setup Project locally

Clone the project

  git clone https://github.com/AOSSIE-Org/Monumento.git

Go to the project directory

  cd Monumento

Install dependencies

  flutter pub get

Create .env using template .env.template and add API keys

cat .env.template > .env

Add the following API keys to the .env file

  • SERVER_CLIENT_ID: Obtain this from the Google Cloud Console for Android configuration.
  • GOOGLE_SIGNIN_APPLE_CLIENT_ID: Obtain this from the Google Cloud Console for iOS configuration.
  • GOOGLE_SIGNIN_WEB_CLIENT_ID: Obtain this from the Google Cloud Console for web configuration.
  • GEOAPIFY_API_KEY: Obtain this from the Geoapify website for fetching location.

Refer to the updated guide below for obtaining these API keys:

Step 2) Configure Firebase

Follow the official Firebase guide to set it up for this project. This will:

  • Add the google-services.json file for Android.
  • Add the GoogleService-Info.plist file for iOS and MacOS.
  • Create the firebase_options.dart file in the lib folder.

Step 3)📜 Populating Monument Data

This script allows you to populate your Firestore database with predefined monument data. It’s a standalone tool that you can run once to seed your database—no need to run or modify any Flutter app.

Prerequisites

  1. Node.js: Install Node.js from https://nodejs.org. Verify installation: node -v You should see a version number like i.e:

  2. Firebase Project with Firestore Enabled:

  1. Service Account Key:
  • In the Firebase console, go to "Project Settings" → "Service accounts".
  • Click "Generate new private key" to download serviceAccountKey.json.
  • Save serviceAccountKey.json in app root directory inside scripts folder.

Step 4) Configure Google Sign-In (Web-Based Flutter App)

To enable Google Sign-In, follow these steps:

  1. Enable Google People API:

    • Go to the Google Cloud Console.
    • Enable the Google People API under the APIs & Services section.
    • Ensure you’ve signed up for the necessary services under your project.

  2. Set CORS Rules for Firebase Storage:

    • If you encounter a 403 Forbidden error when attempting to load images from Firebase Storage, configure your Firebase Storage bucket to allow CORS. Refer to this guide for more details: Handling Firebase Storage 403 Error.

  3. Allow Access-Control-Allow-Origin:

    • For viewing images on the web, ensure that the Firebase Storage bucket has the appropriate Access-Control-Allow-Origin settings. You can follow the steps here: Configuring Access-Control-Allow-Origin.
  1. Install Dependencies:
  • Install the Firebase Admin SDK:
npm install firebase-admin

inside scripts folder, execute the script using the following command:

node populate_monuments.js

If everything goes well, you should see:

Starting to populate the monuments collection...
Monuments collection populated successfully.
  1. Verify in firestore:: Check the Firebase console → Firestore Database → monuments collection. Your data should appear there.

Notes:

  • You can rerun this script whenever you need to seed the data.
  • To add more monuments, modify the monumentsData array before running the script again.