Create a page for apk installation guide

PalisadoesFoundation · Dec 31, 2024 · 808cf60 · 808cf60
1 parent ca8a86f
commit 808cf60
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 2 deletions.
diff --git a/docs-talawa-apk/talawa-apk-guide.md b/docs-talawa-apk/talawa-apk-guide.md
@@ -0,0 +1,76 @@
+---
+title: APK Install Guide
+id: talawa-apk-guide
+description: Welcome to the Talawa documentation site. Learn how to get started with Talawa and more!
+slug: /
+---
+
+
+# Installation for Developers
+Welcome to our installation guide for developers. Jump in and contribute!
+
+# Table of Contents
+
+1. [Pre-Requisites For Developers](#prerequisites-for-developers)
+    - [Talawa-API and Talawa-Admin](#talawa-api-and-talawa-admin) 
+    - [Talawa Mobile App](#talawa-mobile-app) 
+1. [Installation](#installation)
+1. [Operation](#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](https://github.com/PalisadoesFoundation/talawa-api): The API system that the mobile app uses for accessing data.
+1. [Talawa-admin](https://github.com/PalisadoesFoundation/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](#Installation). 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](https://flutter.dev/docs/get-started/install)
+    1. [Android Studio](https://developer.android.com/studio)
+1. **API Environment**: This part is very important.
+    1. Make sure Talawa-API is up and running.
+    1. 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 {#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](https://github.com/PalisadoesFoundation/talawa/releases) 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.
+    ```sh
+    $ git clone https://github.com/PalisadoesFoundation/talawa.git
+    $ cd talawa
+    ```
+1. Install packages.
+    ```sh
+    $ cd talawa_lint
+    $ flutter pub get
+    $ cd ..
+    $ flutter pub get
+    ```
+1. 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](https://github.com/PalisadoesFoundation/talawa-api/blob/-/INSTALLATION.md) file
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -65,6 +65,15 @@ const config = {
         sidebarPath: require.resolve("./sidebar-admin.js"),
       },
     ],
+    [
+      "@docusaurus/plugin-content-docs",
+      {
+        id: "apk",
+        path: "docs-talawa-apk",
+        routeBasePath: "docs-talawa-apk",
+        sidebarPath: undefined,
+      },
+    ],
   ],
   presets: [
     [
@@ -109,7 +118,7 @@ const config = {
         },
         items: [
           {
-            to: "docs/",
+            to: "/",
             activeBasePath: "docs",
             label: "General",
             position: "left",

diff --git a/src/css/custom.css b/src/css/custom.css
@@ -866,4 +866,4 @@ a:hover {
 
 .iconExternalLink_nPIU {
   display: none !important;
-}
+}
diff --git a/src/utils/OrganizationFeatureCard.tsx b/src/utils/OrganizationFeatureCard.tsx
@@ -35,9 +35,11 @@ const OrganizationFeatureCard = () => {
             </p>
           </div>
           <div className="organization-feature-card__footer">
+          <a href="/docs-talawa-apk" rel="noopener noreferrer">
             <button className="organization-feature-card__button">
               Get the App
             </button>
+            </a>
           </div>
         </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -866,4 +866,4 @@ a:hover { @@
     .iconExternalLink_nPIU {
       display: none !important;
-    }
+    }