#3 [GSoC] Update README with build instructions
Merged 2 years ago by a2batic. Opened 2 years ago by amitosh.
amitosh/Fedora-app readme-additions  into  master

file modified
+82 -32

@@ -1,44 +1,94 @@ 

- [Outreachy]

- # Fedora-app

+ # Fedora App

  

- The Fedora Project is a global partnership of free software community members. The Fedora Project is sponsored by Red Hat, which invests in our infrastructure and resources to encourage collaboration and incubate innovative new technologies. Some of these technologies may later be integrated into Red Hat products. They are developed in Fedora and produced under a free and open source license from inception, so other free software communities and projects are free to study, adopt, and modify them. This application talks about articles in Fedora Magazine, queries related to Fedora through Ask Fedora, things going on in Fedora community through Social section and lets you to avail the information of various Fedora meetings.

+ The Fedora Project is a global partnership of free software community members. The Fedora Project is sponsored by Red Hat, which invests in our infrastructure and resources to encourage collaboration and incubate innovative new technologies. Some of these technologies may later be integrated into Red Hat products. They are developed in Fedora and produced under a free and open source license from inception, so other free software communities and projects are free to study, adopt, and modify them.

  

- Note: Contributors contributing through [GSOC'18](https://docs.fedoraproject.org/mentored-projects/gsoc/2018/application.html) or [Outreachy May-Aug '18](https://www.outreachy.org/apply/project-selection/) are recommended to gothrough the guide links carefully.

+ The Fedora App is a central location for Fedora users and innovators to stay updated on The Fedora Project. News updates, social posts, Ask Fedora, as well as articles from Fedora Magazine are all held under this app.

  

- ## Mailing List

- * GSOC : summer-coding@lists.fedoraproject.org

- * Outreachy : outreachy@lists.fedoraproject.org

+ This is the source for the Fedora App.

  

- ## IRC channel (on freenode)

- * GSOC : #fedora-summer-coding

- * Outreachy : #fedora-outreachy

- * Other IRC channels you can shoot your query : #fedora-commops

+ [Fedora App on Google Play Store](https://play.google.com/store/apps/details?id=com.fedoraqa.fedora)

  

- 

- ## Fedora App UX

- 

- The Fedora App is a central location for Fedora users and innovators to stay updated on The Fedora Project. News updates, social posts, Ask Fedora, as well as articles from Fedora Magazine are all held under this app. 

  ## Current features

+ 

  1. Fedora Magazine

- - Browse recent articles from Fedora Magazine

- - Share articles via Facebook, e-Mail, text, and more

- - Be taken directly to FM official site 

+    * Browse recent articles from Fedora Magazine

+    * Share articles via Facebook, e-Mail, text, and more

+    * Be taken directly to Fedora Magazine official site.

  2. Fedora Social

- - View updates of Fedora's Facebook news Feed

- - Also links to official Facebook page

+    * View updates of Fedora's Facebook news Feed

+    * Also links to official Facebook page

  3. Ask Fedora

- - Ask questions about Fedora Linux of The Fedora Project to the public forum

- - Share questions and comments 

- - Active in pop up window

- - Search, vote, and answer questions

+    * Browse and ask questions about Fedora Linux to Ask Fedora

+    * Share questions and comments.

+    * Search, vote, and answer questions.

  4. Fedora Calendar

- - View events for Fedora from all different categories including QA, budget, classroom, etc.

- - Add event to personal Google Calendar directly from app

- - View the date, time, and description of the event 

+    * View events for Fedora from all different SIGs including QA, budget, classroom, etc.

+    * Add event to device calendar directly from app.

+    * View the date, time, and description of the event.

+ 

+ ## Pre-requisites

+ 

+ * [Download the installer](https://nodejs.org/) for Node.js 6 or greater.

+   * You can also install NodeJS LTS from Fedora repos using dnf: `sudo dnf install nodejs`

+ * Install the ionic CLI globally: `npm install -g ionic`

+ * Install compilers and headers, required by native addons:

+   * [Python](https://developer.fedoraproject.org/tech/languages/python/python-installation.html)

+     * `sudo dnf install python2`

+     * Note: Python 3 is _not supported_. See the requirements [here](https://github.com/nodejs/node-gyp#installation).

+   * [GCC, G++ and make](https://developer.fedoraproject.org/tech/languages/c/c_installation.html)

+     * `sudo dnf install gcc gcc-c++ make`

+   * [GNU Autotools](https://developer.fedoraproject.org/tech/languages/c/autotools.html)

+     * `sudo dnf install autoconf automake`

+   * libpng headers

+     * `sudo dnf install libpng-devel`

+ 

+ _Note: You may need to add “sudo” in front of any global commands to install the utilities. See [npm documentation](https://docs.npmjs.com/getting-started/fixing-npm-permissions) for more details._

+ 

+ ### Building for Android

+ 

+ * Install Java compilers: `sudo dnf install java-devel`

+ * Install [Android SDK](https://developer.android.com/studio/index.html) and the system packages documented [here](https://developer.fedoraproject.org/start/sw/mobile-app/mobile-installation.html)

+ * Install Gradle. Unfortunately, Fedora repos includes a rather old version of Gradle, so we recommend you to follow the instructions documented [here](https://gradle.org/install/#with-a-package-manager)

+ * Configure your `JAVA_HOME` and `ANDROID_HOME` to point to Java and Android SDK installation directories respectively.

+ 

+ ## Getting Started

+ 

+ * Clone this repository: `git clone https://github.com/sumantro93/Fedora-Community-App.git`.

+ * Run `npm install` from the project root.

+ * Run `ionic serve` in a terminal from the project root.

+ * Open http://localhost:8100 to preview your app.

+ * Profit. :tada:

+ 

+ ## Deploying

+ 

+ * PWA - Run `npm run ionic:build --prod` and then push the `www` folder to your favorite hosting service

+ * Android - Run `ionic cordova run android --prod`

+ * iOS - Run `ionic cordova run ios --prod`

+ 

+ _Ommitting the `--prod` will generate a debug build which is useful for Android/iOS remote debugging._

+ 

+ ### Using Ionic DevApp for rapid testing on mobile devices

+ 

+ [Ionic DevApp](https://ionicframework.com/docs/pro/devapp/) is a free app that makes it easy to run your Ionic apps directly on an iOS or Android device. This avoids the cumbersome Native SDK installations.

+ 

+ * Install Ionic DevApp on your phone.

+ * Connect your phone and computer to the same network.

+ * Run `ionic serve -c` from the project root.

+ * Open Ionic DevApp and lanuch Fedora app from the list of available apps.

+ 

+ _Note: Network policies and firewalls may interfere with Ionic DevApp, in that case try on a different network_

+ 

+ ## For GSoC and Outreachy

+ 

+ Contributors contributing through [GSOC'18](https://docs.fedoraproject.org/mentored-projects/gsoc/2018/application.html) or [Outreachy May-Aug '18](https://www.outreachy.org/apply/project-selection/) are recommended to gothrough the guide links carefully.

+ 

+ ### Mailing List

+ 

+ * GSOC: [summer-coding@lists.fedoraproject.org](mailto:summer-coding@lists.fedoraproject.org)

+ * Outreachy: [outreachy@lists.fedoraproject.org](mailto:outreachy@lists.fedoraproject.org)

  

- ## Setting up instructions

- [The Fedora app can be downloaded here] (https://play.google.com/store/apps/details?id=com.fedoraqa.fedora)

-  

- [Fedora Linux installation guide] (https://docs.fedoraproject.org/f27/install-guide/index.html) 

+ ### IRC channel (on freenode)

  

- [Download versions of Fedora] (https://getfedora.org/)

+ * GSOC: [#fedora-summer-coding](https://webchat.freenode.net?channels=%23fedora-summer-coding)

+ * Outreachy: [#fedora-outreachy](https://webchat.freenode.net?channels=%23fedora-outreachy)

+ * Other IRC channels you can shoot your query: [#fedora-commops]([https://webchat.freenode.net?channels=%23fedora-commops])

Contains steps to quickly get the app running.

  • [x] General description of what this app does
  • [x] Pre-requisites
  • [x] Build instructions
  • [x] Testing instructions

rebased onto 58d1b9aa3d4f304a3fd9d35a69b5e13ca755166b

2 years ago

@amitosh, please update this PR according to the build additions (if any).

We need not add this point "To install the latest ...", as sudo dnf install nodejs will install the latest nodejs available for that OS automatically.

1 new commit added

  • Add note about Ionic DevApp
2 years ago

@a2batic I have added all the relevant build instructions.

1 new commit added

  • Remove refs to NodeSource repos
2 years ago

1 new commit added

  • Add apk building instructions
2 years ago

rebased onto 5b59d2af85d6ca7e46a85234e2f266ce10aa2d86

2 years ago

@amitosh, please rebase and update your patch.

Also, Add [GSoC] in front of your PR message and if possible in commit message as well.

rebased onto c41465c306ebcab398eb9a3de2a3fd0e4f3d5bc6

2 years ago

@amitosh, please rebase it again, PR#6, has been merged.

rebased onto a413b26

2 years ago

Pull-Request has been merged by a2batic

2 years ago
Metadata