Skip to content

Latest commit

 

History

History
67 lines (54 loc) · 3.81 KB

INSTALLATION.md

File metadata and controls

67 lines (54 loc) · 3.81 KB
Raw

Installation for Developers

Welcome to our installation guide for developers. Jump in and contribute!

Table of Contents

  1. Pre-Requisites For Developers
  2. Installation
  3. Operation

Prerequisites for Developers

We recommend that you follow these steps before beginning development work on the Talawa mobile app.

Talawa-API and Talawa-Admin

For best results you should setup your own local instances of:

  1. Talawa-API: The API system that the mobile app uses for accessing data.
  2. Talawa-admin: The system used by Administrators to manage user information. This is important as you will occasionally need to do administrative functions that cannot be done in the mobile app.

The INSTALLATION.md files in both repositories show you how. The Talawa-API INSTALLATION.md will also show you the Organization URL to use when you first login to Talawa mobile.

Talawa Mobile App

You'll need to set up the IDE and mobile device emulator on your local system and have access to a system running the Talawa API, which the mobile needs to access to operate properly.

  1. Development Environment: You'll need to have the following installed:
    1. Flutter SDK
    2. Android Studio
  2. API Environment: This part is very important.
    1. Make sure Talawa-API is up and running.
    2. You will need to enter the URL of the API server in the Talawa app when it first starts up. The URL could be active on a system you control or in our test environment. The Talawa-API INSTALLATION.md will provide that information.
  3. Google APIs (Optional): The app uses Google Maps API for venue selection. You will need to sign up for it if you want to test these features.
    1. Maps API Setup: Follow these steps:
      1. Go to Google Developers Console.
      2. Create a new project that you want to enable Google Maps on.
      3. Search credentials in the search bar and select Credentials in APIs & Services. Click on Create credentials and select API key. Copy the key and replace it as said before.
      4. Search maps sdk for android and select the Google Maps SDK for Android in Marketplace. You can also search maps sdk for ios and select the Google Maps SDK for iOS in Marketplace for iOS devices.
      5. Click Enable.
    2. Mobile App Setup: Enter your API key in the:
      1. android/app/src/main/AndroidManifest.xml file for Android.
      2. ios/Runner/AppDelegate.swift file for iOS.
        1. Replace YOUR_KEY_HERE with your API key.
      3. Remember to remove the key before committing changes and replace again with YOUR_KEY_HERE.

Installation

We have tried to make the process simple. Here's what you need to do.

  1. Clone and change into the project. 
    $ git clone https://github.com/PalisadoesFoundation/talawa.git
$ cd talawa
  2. Install packages. 
    $ cd talawa_lint
$ flutter pub get
$ cd ..
$ flutter pub get
  3. Start developing!

Operation

The Talawa Mobile app communicates with a Talawa-API server to get all its data. This access is provided via a URL. When you first run the Talawa Mobile App you'll be prompted for the organization URL of a Talawa-API server. The URL to use will vary depending on the way you are using the Talawa Mobile app.

For a list of organization URLs for each scenario, please refer to the Talawa-API INSTALLATION.md file