Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 3.89 KB

INSTALLATION.md

File metadata and controls

68 lines (51 loc) · 3.89 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

Note: If you are an Android user, you may choose to directly use the apk file provided in this repo, and skip the manual setup part. For more information about this, see the Installation section. But if you want to setup the development environment for yourself, read along.

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.

Installation

You can start using Talawa by any of the two methods:

  1. Install the apk provided in the release section of this repo. It is built against the latest codebase. Please note that the release is provided only for Android. For iOS, you will still need to build the app yourself.
    • Head over to the release section of Talawa repository.
    • You will find a release with the name of Automated Android Release. Scroll a bit and you will find a file named app-release.apk. Click on it and have it downloaded.
    • Head over to the downloads of your browser and then click on app-release.apk there. That will ask you to install the app. Click on Install.
    • Once done, you can find Talawa in your apps list. Start using it from right there :)
  2. Manually build the app by below described steps.

Manual Build and 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