Revert "Revert "Fixes #2074: Simplifies documentation (#2101)" (#2107)…

…" (#2108) This reverts commit c0e9064.
fossasia · Aug 19, 2019 · 9d94e2d · 9d94e2d
1 parent c0e9064
commit 9d94e2d
Show file tree

Hide file tree

Showing 112 changed files with 126 additions and 123 deletions.
diff --git a/README.md b/README.md
@@ -35,8 +35,8 @@ The user can:
 
 Badgeyay's frontend and backend can be deployed easily and a detailed installation instruction of frontend and backend have been provided below.
 
-1. [Badgeyay Frontend](/frontend/README.md)
-2. [Badgeyay Backend](/api/README.md)
+1. [Badgeyay Frontend](/docs/frontend/installation/README.md)
+2. [Badgeyay Backend](/docs/backend/installation/README.md)
 3. **Installing git pre-push hook:**
    - Run file `scripts/install-hook.py`. It will copy contents of `scripts/pre-push-hook.py` to `.git/hooks/pre-push`. Make sure that you have `.git/hooks/pre-push.sample` in your `.git` directory before performing this step.
    - This will install git `pre-push-hook` in your local `.git` directory. It will run the commits against linting tests before pushing to a remote. See `scripts/pre-push-hook.py` if you encounter any errors.

diff --git a/api/.gitignore → backend/.gitignore b/api/.gitignore → backend/.gitignore
diff --git a/api/Dockerfile → backend/Dockerfile b/api/Dockerfile → backend/Dockerfile
diff --git a/backend/README.md b/backend/README.md
@@ -0,0 +1,8 @@
+# Badgeyay Backend
+
+> **Badgeyay provide an interface to event organizers for generating badges of events from concerts to conferences and meet-ups.**
+
+Badgeyay is an awesome Badge generator with a simple web UI to add data and generate printable badges in a PDF.
+
+This directory contains the backend for badgeyay.
+[Installation instructions](/docs/backend/installation/README.md)
diff --git a/api/__init__.py → backend/__init__.py b/api/__init__.py → backend/__init__.py
diff --git a/api/badge_backgrounds/black_futuristic.png → ...nd/badge_backgrounds/black_futuristic.png b/api/badge_backgrounds/black_futuristic.png → ...nd/badge_backgrounds/black_futuristic.png
diff --git a/api/badge_backgrounds/blue_futuristic.png → ...end/badge_backgrounds/blue_futuristic.png b/api/badge_backgrounds/blue_futuristic.png → ...end/badge_backgrounds/blue_futuristic.png
diff --git a/api/badge_backgrounds/cyan_futuristic.png → ...end/badge_backgrounds/cyan_futuristic.png b/api/badge_backgrounds/cyan_futuristic.png → ...end/badge_backgrounds/cyan_futuristic.png
diff --git a/api/badge_backgrounds/gray_futuristic.png → ...end/badge_backgrounds/gray_futuristic.png b/api/badge_backgrounds/gray_futuristic.png → ...end/badge_backgrounds/gray_futuristic.png
diff --git a/api/badge_backgrounds/green_futuristic.png → ...nd/badge_backgrounds/green_futuristic.png b/api/badge_backgrounds/green_futuristic.png → ...nd/badge_backgrounds/green_futuristic.png
diff --git a/api/badge_backgrounds/red_futuristic.png → backend/badge_backgrounds/red_futuristic.png b/api/badge_backgrounds/red_futuristic.png → backend/badge_backgrounds/red_futuristic.png
diff --git a/api/badge_backgrounds/user_defined.png → backend/badge_backgrounds/user_defined.png b/api/badge_backgrounds/user_defined.png → backend/badge_backgrounds/user_defined.png
diff --git a/api/badge_backgrounds/yellow_futuristic.png → ...d/badge_backgrounds/yellow_futuristic.png b/api/badge_backgrounds/yellow_futuristic.png → ...d/badge_backgrounds/yellow_futuristic.png
diff --git a/api/config/ServiceAccountkey.json → backend/config/ServiceAccountkey.json b/api/config/ServiceAccountkey.json → backend/config/ServiceAccountkey.json
diff --git a/api/config/__init__.py → backend/config/__init__.py b/api/config/__init__.py → backend/config/__init__.py
diff --git a/api/config/app.example.yaml → backend/config/app.example.yaml b/api/config/app.example.yaml → backend/config/app.example.yaml
diff --git a/api/config/config.py → backend/config/config.py b/api/config/config.py → backend/config/config.py
diff --git a/api/config/dev_config.py → backend/config/dev_config.py b/api/config/dev_config.py → backend/config/dev_config.py
diff --git a/api/config/urlConfig.py → backend/config/urlConfig.py b/api/config/urlConfig.py → backend/config/urlConfig.py
diff --git a/api/controllers/__init__.py → backend/controllers/__init__.py b/api/controllers/__init__.py → backend/controllers/__init__.py
diff --git a/api/controllers/admin.py → backend/controllers/admin.py b/api/controllers/admin.py → backend/controllers/admin.py
diff --git a/api/controllers/assetHelper.py → backend/controllers/assetHelper.py b/api/controllers/assetHelper.py → backend/controllers/assetHelper.py
diff --git a/api/controllers/changeMeta.py → backend/controllers/changeMeta.py b/api/controllers/changeMeta.py → backend/controllers/changeMeta.py
diff --git a/api/controllers/changePermissions.py → backend/controllers/changePermissions.py b/api/controllers/changePermissions.py → backend/controllers/changePermissions.py
diff --git a/api/controllers/errorHandlers.py → backend/controllers/errorHandlers.py b/api/controllers/errorHandlers.py → backend/controllers/errorHandlers.py
diff --git a/api/controllers/exportData.py → backend/controllers/exportData.py b/api/controllers/exportData.py → backend/controllers/exportData.py
diff --git a/api/controllers/fileUploader.py → backend/controllers/fileUploader.py b/api/controllers/fileUploader.py → backend/controllers/fileUploader.py
diff --git a/api/controllers/generateBadges.py → backend/controllers/generateBadges.py b/api/controllers/generateBadges.py → backend/controllers/generateBadges.py
diff --git a/api/controllers/loginUser.py → backend/controllers/loginUser.py b/api/controllers/loginUser.py → backend/controllers/loginUser.py
diff --git a/api/controllers/modifyUser.py → backend/controllers/modifyUser.py b/api/controllers/modifyUser.py → backend/controllers/modifyUser.py
diff --git a/api/controllers/oauthToken.py → backend/controllers/oauthToken.py b/api/controllers/oauthToken.py → backend/controllers/oauthToken.py
diff --git a/api/controllers/registerUser.py → backend/controllers/registerUser.py b/api/controllers/registerUser.py → backend/controllers/registerUser.py
diff --git a/api/controllers/resetUser.py → backend/controllers/resetUser.py b/api/controllers/resetUser.py → backend/controllers/resetUser.py
diff --git a/api/controllers/stripePay.py → backend/controllers/stripePay.py b/api/controllers/stripePay.py → backend/controllers/stripePay.py
diff --git a/api/controllers/updateProfile.py → backend/controllers/updateProfile.py b/api/controllers/updateProfile.py → backend/controllers/updateProfile.py
diff --git a/api/controllers/validation.py → backend/controllers/validation.py b/api/controllers/validation.py → backend/controllers/validation.py
diff --git a/api/db.py → backend/db.py b/api/db.py → backend/db.py
diff --git a/api/docker-compose.yml → backend/docker-compose.yml b/api/docker-compose.yml → backend/docker-compose.yml
diff --git a/api/helpers/__init__.py → backend/helpers/__init__.py b/api/helpers/__init__.py → backend/helpers/__init__.py
diff --git a/api/helpers/uploads.py → backend/helpers/uploads.py b/api/helpers/uploads.py → backend/helpers/uploads.py
diff --git a/api/helpers/verifyPassword.py → backend/helpers/verifyPassword.py b/api/helpers/verifyPassword.py → backend/helpers/verifyPassword.py
diff --git a/api/helpers/verifyToken.py → backend/helpers/verifyToken.py b/api/helpers/verifyToken.py → backend/helpers/verifyToken.py
diff --git a/api/migrations/README → backend/migrations/README b/api/migrations/README → backend/migrations/README
diff --git a/api/migrations/alembic.ini → backend/migrations/alembic.ini b/api/migrations/alembic.ini → backend/migrations/alembic.ini
diff --git a/api/migrations/env.py → backend/migrations/env.py b/api/migrations/env.py → backend/migrations/env.py
diff --git a/api/migrations/script.py.mako → backend/migrations/script.py.mako b/api/migrations/script.py.mako → backend/migrations/script.py.mako
diff --git a/api/migrations/versions/2780e9c4144f_.py → backend/migrations/versions/2780e9c4144f_.py b/api/migrations/versions/2780e9c4144f_.py → backend/migrations/versions/2780e9c4144f_.py
diff --git a/api/migrations/versions/44af135eb41b_.py → backend/migrations/versions/44af135eb41b_.py b/api/migrations/versions/44af135eb41b_.py → backend/migrations/versions/44af135eb41b_.py
diff --git a/api/migrations/versions/90bcaf09b4eb_.py → backend/migrations/versions/90bcaf09b4eb_.py b/api/migrations/versions/90bcaf09b4eb_.py → backend/migrations/versions/90bcaf09b4eb_.py
diff --git a/api/migrations/versions/9f78f55cf7f3_.py → backend/migrations/versions/9f78f55cf7f3_.py b/api/migrations/versions/9f78f55cf7f3_.py → backend/migrations/versions/9f78f55cf7f3_.py
diff --git a/api/migrations/versions/b6414a3cd355_.py → backend/migrations/versions/b6414a3cd355_.py b/api/migrations/versions/b6414a3cd355_.py → backend/migrations/versions/b6414a3cd355_.py
diff --git a/api/migrations/versions/cb411916be68_.py → backend/migrations/versions/cb411916be68_.py b/api/migrations/versions/cb411916be68_.py → backend/migrations/versions/cb411916be68_.py
diff --git a/api/migrations/versions/efb1c182508b_.py → backend/migrations/versions/efb1c182508b_.py b/api/migrations/versions/efb1c182508b_.py → backend/migrations/versions/efb1c182508b_.py
diff --git a/api/models/__init__.py → backend/models/__init__.py b/api/models/__init__.py → backend/models/__init__.py
diff --git a/api/models/admin.py → backend/models/admin.py b/api/models/admin.py → backend/models/admin.py
diff --git a/api/models/badges.py → backend/models/badges.py b/api/models/badges.py → backend/models/badges.py
diff --git a/api/models/file.py → backend/models/file.py b/api/models/file.py → backend/models/file.py
diff --git a/api/models/modules.py → backend/models/modules.py b/api/models/modules.py → backend/models/modules.py
diff --git a/api/models/permissions.py → backend/models/permissions.py b/api/models/permissions.py → backend/models/permissions.py
diff --git a/api/models/settings.py → backend/models/settings.py b/api/models/settings.py → backend/models/settings.py
diff --git a/api/models/socialContent.py → backend/models/socialContent.py b/api/models/socialContent.py → backend/models/socialContent.py
diff --git a/api/models/stripe.py → backend/models/stripe.py b/api/models/stripe.py → backend/models/stripe.py
diff --git a/api/models/token.py → backend/models/token.py b/api/models/token.py → backend/models/token.py
diff --git a/api/models/user.py → backend/models/user.py b/api/models/user.py → backend/models/user.py
diff --git a/api/models/utils.py → backend/models/utils.py b/api/models/utils.py → backend/models/utils.py
diff --git a/api/requirements.txt → backend/requirements.txt b/api/requirements.txt → backend/requirements.txt
diff --git a/api/run.py → backend/run.py b/api/run.py → backend/run.py
diff --git a/api/schemas/admin.py → backend/schemas/admin.py b/api/schemas/admin.py → backend/schemas/admin.py
diff --git a/api/schemas/badges.py → backend/schemas/badges.py b/api/schemas/badges.py → backend/schemas/badges.py
diff --git a/api/schemas/errors.py → backend/schemas/errors.py b/api/schemas/errors.py → backend/schemas/errors.py
diff --git a/api/schemas/file.py → backend/schemas/file.py b/api/schemas/file.py → backend/schemas/file.py
diff --git a/api/schemas/modules.py → backend/schemas/modules.py b/api/schemas/modules.py → backend/schemas/modules.py
diff --git a/api/schemas/operation.py → backend/schemas/operation.py b/api/schemas/operation.py → backend/schemas/operation.py
diff --git a/api/schemas/permissions.py → backend/schemas/permissions.py b/api/schemas/permissions.py → backend/schemas/permissions.py
diff --git a/api/schemas/token.py → backend/schemas/token.py b/api/schemas/token.py → backend/schemas/token.py
diff --git a/api/schemas/user.py → backend/schemas/user.py b/api/schemas/user.py → backend/schemas/user.py
diff --git a/api/schemas/utils.py → backend/schemas/utils.py b/api/schemas/utils.py → backend/schemas/utils.py
diff --git a/api/static/badges/4.5x4onA2.svg → backend/static/badges/4.5x4onA2.svg b/api/static/badges/4.5x4onA2.svg → backend/static/badges/4.5x4onA2.svg
diff --git a/api/static/badges/4.5x4onA3.svg → backend/static/badges/4.5x4onA3.svg b/api/static/badges/4.5x4onA3.svg → backend/static/badges/4.5x4onA3.svg
diff --git a/api/static/badges/4.5x4onA4.svg → backend/static/badges/4.5x4onA4.svg b/api/static/badges/4.5x4onA4.svg → backend/static/badges/4.5x4onA4.svg
diff --git a/api/static/badges/4.5x4onUS_Letter.svg → backend/static/badges/4.5x4onUS_Letter.svg b/api/static/badges/4.5x4onUS_Letter.svg → backend/static/badges/4.5x4onUS_Letter.svg
diff --git a/api/static/badges/4x3onA2.svg → backend/static/badges/4x3onA2.svg b/api/static/badges/4x3onA2.svg → backend/static/badges/4x3onA2.svg
diff --git a/api/static/badges/4x3onA3.svg → backend/static/badges/4x3onA3.svg b/api/static/badges/4x3onA3.svg → backend/static/badges/4x3onA3.svg
diff --git a/api/static/badges/4x3onA4.svg → backend/static/badges/4x3onA4.svg b/api/static/badges/4x3onA4.svg → backend/static/badges/4x3onA4.svg
diff --git a/api/static/badges/4x3onUS_Letter.svg → backend/static/badges/4x3onUS_Letter.svg b/api/static/badges/4x3onUS_Letter.svg → backend/static/badges/4x3onUS_Letter.svg
diff --git a/api/static/badges/8BadgesOnA3.svg → backend/static/badges/8BadgesOnA3.svg b/api/static/badges/8BadgesOnA3.svg → backend/static/badges/8BadgesOnA3.svg
diff --git a/api/svg/user_defined.svg → backend/svg/user_defined.svg b/api/svg/user_defined.svg → backend/svg/user_defined.svg
diff --git a/api/utils/__init__.py → backend/utils/__init__.py b/api/utils/__init__.py → backend/utils/__init__.py
diff --git a/api/utils/dimen.py → backend/utils/dimen.py b/api/utils/dimen.py → backend/utils/dimen.py
diff --git a/api/utils/encryptUtil.py → backend/utils/encryptUtil.py b/api/utils/encryptUtil.py → backend/utils/encryptUtil.py
diff --git a/api/utils/errors.py → backend/utils/errors.py b/api/utils/errors.py → backend/utils/errors.py
diff --git a/api/utils/firebaseUploader.py → backend/utils/firebaseUploader.py b/api/utils/firebaseUploader.py → backend/utils/firebaseUploader.py
diff --git a/api/utils/generate_badges.py → backend/utils/generate_badges.py b/api/utils/generate_badges.py → backend/utils/generate_badges.py
diff --git a/api/utils/mail.py → backend/utils/mail.py b/api/utils/mail.py → backend/utils/mail.py
diff --git a/api/utils/merge_badges.py → backend/utils/merge_badges.py b/api/utils/merge_badges.py → backend/utils/merge_badges.py
diff --git a/api/utils/response.py → backend/utils/response.py b/api/utils/response.py → backend/utils/response.py
diff --git a/api/utils/svg_to_png.py → backend/utils/svg_to_png.py b/api/utils/svg_to_png.py → backend/utils/svg_to_png.py
diff --git a/api/utils/update_user.py → backend/utils/update_user.py b/api/utils/update_user.py → backend/utils/update_user.py
diff --git a/api/README.md → docs/backend/installation/README.md b/api/README.md → docs/backend/installation/README.md
@@ -1,9 +1,3 @@
-# Badgeyay Backend
-
-> **Badgeyay provide an interface to event organizers for generating badges of events from concerts to conferences and meet-ups.**
-
-Badgeyay is an awesome Badge generator with a simple web UI to add data and generate printable badges in a PDF.
-
 ## Prerequisites
 
 Badgeyay backend depends on:

diff --git a/api/docs/installation/aws.md → docs/backend/installation/aws.md b/api/docs/installation/aws.md → docs/backend/installation/aws.md
@@ -101,7 +101,7 @@ $ git clone https://github.com/fossasia/badgeyay.git && cd badgeyay
 * **Step 3** - Now we need to build the Docker image for Badgeyay
 
 ```sh
-$ cd api/
+$ cd backend/
 $ docker-Compose build
 ```
 

diff --git a/api/docs/installation/aws/aws1.png → docs/backend/installation/aws/aws1.png b/api/docs/installation/aws/aws1.png → docs/backend/installation/aws/aws1.png
diff --git a/api/docs/installation/aws/aws2.png → docs/backend/installation/aws/aws2.png b/api/docs/installation/aws/aws2.png → docs/backend/installation/aws/aws2.png
diff --git a/api/docs/installation/aws/aws3.png → docs/backend/installation/aws/aws3.png b/api/docs/installation/aws/aws3.png → docs/backend/installation/aws/aws3.png
diff --git a/api/docs/installation/aws/aws4.png → docs/backend/installation/aws/aws4.png b/api/docs/installation/aws/aws4.png → docs/backend/installation/aws/aws4.png
diff --git a/api/docs/installation/demo.gif → docs/backend/installation/demo.gif b/api/docs/installation/demo.gif → docs/backend/installation/demo.gif
diff --git a/api/docs/installation/docker.md → docs/backend/installation/docker.md b/api/docs/installation/docker.md → docs/backend/installation/docker.md
@@ -14,7 +14,7 @@
 * **Step 1** - Clone the project and `cd` into it.
 
 ```bash
-git clone https://github.com/fossasia/badgeyay.git && cd badgeyay/api
+git clone https://github.com/fossasia/badgeyay.git && cd badgeyay/backend
 ```
 
 * **Step 2** - Then set the required `SERVER_NAME` environment variable. `SERVER_NAME` should the same as the domain on which the server is running and it should not include 'http', 'https',

diff --git a/api/docs/installation/heroku.md → docs/backend/installation/heroku.md b/api/docs/installation/heroku.md → docs/backend/installation/heroku.md
diff --git a/api/docs/installation/localvag.md → docs/backend/installation/localvag.md b/api/docs/installation/localvag.md → docs/backend/installation/localvag.md
diff --git a/api/docs/installation/localvir.md → docs/backend/installation/localvir.md b/api/docs/installation/localvir.md → docs/backend/installation/localvir.md
@@ -40,7 +40,7 @@ $ git remote add upstream https://github.com/fossasia/badgeyay.git
     * System Wide Installation
 
     ```sh
-    sudo -H pip3 install -r api/requirements.txt
+    sudo -H pip3 install -r backend/requirements.txt
     ```
     Note: Errors might result here, just see which package is unmet, and just install them using the distro's package manager. You may need to upgrade your pip version
 
@@ -72,7 +72,7 @@ $ git remote add upstream https://github.com/fossasia/badgeyay.git
   * Install all the requirements.
 
   ```sh
-  (badgeyay)$ pip install -r api/requirements.txt
+  (badgeyay)$ pip3 install -r backend/requirements.txt
   ```
 
 - **Postgres Installation**
@@ -146,14 +146,14 @@ It is necessary to run both the ember server and as well as the python backend s
 Then, in a terminal, type
 
 ```sh
-(badgeyay/api) $ export FLASK_APP=run.py
-(badgeyay/api)$ flask run
+(badgeyay/backend) $ export FLASK_APP=run.py
+(badgeyay/backend)$ flask run
 ```
 
  * To run the project on a local machine (debug mode).
 ```sh
-(badgeyay/api) $ export FLASK_DEBUG=1
-(badgeyay/api)$ flask run
+(badgeyay/backend) $ export FLASK_DEBUG=1
+(badgeyay/backend)$ flask run
 ```
 If Flask Run does not work on Mac Try using :
 ```py

diff --git a/docs/frontend/installation/README.md b/docs/frontend/installation/README.md
@@ -0,0 +1,106 @@
+## Prerequisites
+
+You will need the following things properly installed on your computer.
+
+* [Git](https://git-scm.com/)
+* [Node.js](https://nodejs.org/) (with npm) (Preferred version is v9.11.2) (It's tricky to install npm on most system, maybe use nvm)
+* [Ember CLI](https://ember-cli.com/)
+* [Google Chrome](https://google.com/chrome/) (for testing purposes only)
+
+## Installation
+
+To install the app, run the following commands in a command line:
+
+* `git clone https://github.com/fossasia/badgeyay`
+* `cd badgeyay/frontend`
+* `npm install`
+* `bower install`
+## Running locally:
+
+To run the app locally on your machine, run the following commands in a command line:
+
+* `ember serve`
+* Visit your app at [http://localhost:4200](http://localhost:4200).
+* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
+
+### Running Tests
+
+* `ember test`
+* `ember test --server`
+
+### Building
+
+* `ember build` (development)
+* `ember build --environment production` (production)
+
+### Deploying on Kubernetes
+
+For deploying on Kubernetes, you need following things properly installed on your local machine:
+
+* [Docker](https://docs.docker.com/install/)
+* [Docker Machine](https://docs.docker.com/machine/install-machine/)
+* [Google Cloud SDK](https://cloud.google.com/sdk/docs/quickstarts)
+* [VirtualBox](https://www.virtualbox.org/wiki/Linux_Downloads)
+
+  #### Enabling Google Kubernetes Engine API:
+  *  Visit the [Kubernetes Engine page](https://console.cloud.google.com/projectselector/kubernetes?_ga=2.190554988.-672712410.1518259944) in the Google Cloud Platform Console.
+  * Create or select a project.
+  * Wait for the API and related services to be enabled.
+
+  ##### Creating local VM
+  * `docker-machine create --driver virtualbox default`
+  * `docker-machine env default`
+  * `eval "$(docker-machine env default)"`
+
+  ##### Installing Kubernetes Command line tool:
+  * `gcloud components install kubectl`
+
+  ##### Building and deploying the container image:
+  * `export PROJECT_ID="$(gcloud config get-value project -q)"`
+  * `docker build -t gcr.io/${PROJECT_ID}/badgeyay:v1 .` (Build Container Image)
+  * `gcloud docker -- push gcr.io/${PROJECT_ID}/badgeyay:v1` (Push Container Image)
+  * `gcloud container clusters create badgeyay-cluster --num-nodes=3` (Create Container cluster)
+  * `kubectl run badgeyay-web --image=gcr.io/${PROJECT_ID}/badgeyay:v1 --port 4200` (Deploy your application)
+  * `kubectl expose deployment badgeyay-web --type=LoadBalancer --port 80 --target-port 4200` (Expose deployment over the Internet)
+  * `kubectl get service`
+  * Copy the External-IP from the showed list corresponding to your cluster's name and run it in your browser.
+
+# Deploying on Heroku :
+
+## Prerequisites
+
+You will need the following things properly installed on your computer.
+
+Git
+Node.js (with NPM)
+Ember CLI
+PhantomJS
+Running Locally
+
+````
+$ git clone https://github.com/fossasia/badgeyay
+$ cd badgeyay/frontend
+$ yarn install
+$ ember server
+````
+
+Your app should now be running on localhost:4200.
+
+## Deploying to Heroku
+
+````
+$ heroku create --buildpack https://codon-buildpacks.s3.amazonaws.com/buildpacks/heroku/emberjs.tgz
+$ git push heroku master
+$ heroku open
+````
+
+
+
+## Further Reading / Useful Links
+
+* [Heroku Ember.js Buildpack](https://github.com/heroku/heroku-buildpack-emberjs)
+* [ember.js](https://emberjs.com/)
+* [ember-cli](https://ember-cli.com/)
+* Development Browser Extensions
+  * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
+  * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
diff --git a/frontend/README.md b/frontend/README.md
@@ -8,109 +8,4 @@ This directory contains the frontend for badgeyay.
 
 > Note to mobile users: On google chrome of mobile device, you need to **disable data saver** option in settings to open the [website](http://badgeyay.com/). Try clearing cache and cookies if the problem still persists.
 
-## Prerequisites
-
-You will need the following things properly installed on your computer.
-
-* [Git](https://git-scm.com/)
-* [Node.js](https://nodejs.org/) (with npm) (Preferred version is v9.11.2) (It's tricky to install npm on most system, maybe use nvm)
-* [Ember CLI](https://ember-cli.com/)
-* [Google Chrome](https://google.com/chrome/) (for testing purposes only)
-
-## Installation
-
-To install the app, run the following commands in a command line:
-
-* `git clone https://github.com/fossasia/badgeyay`
-* `cd badgeyay/frontend`
-* `npm install`
-* `bower install`
-## Running locally:
-
-To run the app locally on your machine, run the following commands in a command line:
-
-* `ember serve`
-* Visit your app at [http://localhost:4200](http://localhost:4200).
-* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
-
-### Running Tests
-
-* `ember test`
-* `ember test --server`
-
-### Building
-
-* `ember build` (development)
-* `ember build --environment production` (production)
-
-### Deploying on Kubernetes
-
-For deploying on Kubernetes, you need following things properly installed on your local machine:
-
-* [Docker](https://docs.docker.com/install/)
-* [Docker Machine](https://docs.docker.com/machine/install-machine/)
-* [Google Cloud SDK](https://cloud.google.com/sdk/docs/quickstarts)
-* [VirtualBox](https://www.virtualbox.org/wiki/Linux_Downloads)
-
-  #### Enabling Google Kubernetes Engine API:
-  *  Visit the [Kubernetes Engine page](https://console.cloud.google.com/projectselector/kubernetes?_ga=2.190554988.-672712410.1518259944) in the Google Cloud Platform Console.
-  * Create or select a project.
-  * Wait for the API and related services to be enabled.
-
-  ##### Creating local VM
-  * `docker-machine create --driver virtualbox default`
-  * `docker-machine env default`
-  * `eval "$(docker-machine env default)"`
-
-  ##### Installing Kubernetes Command line tool:
-  * `gcloud components install kubectl`
-
-  ##### Building and deploying the container image:
-  * `export PROJECT_ID="$(gcloud config get-value project -q)"`
-  * `docker build -t gcr.io/${PROJECT_ID}/badgeyay:v1 .` (Build Container Image)
-  * `gcloud docker -- push gcr.io/${PROJECT_ID}/badgeyay:v1` (Push Container Image)
-  * `gcloud container clusters create badgeyay-cluster --num-nodes=3` (Create Container cluster)
-  * `kubectl run badgeyay-web --image=gcr.io/${PROJECT_ID}/badgeyay:v1 --port 4200` (Deploy your application)
-  * `kubectl expose deployment badgeyay-web --type=LoadBalancer --port 80 --target-port 4200` (Expose deployment over the Internet)
-  * `kubectl get service`
-  * Copy the External-IP from the showed list corresponding to your cluster's name and run it in your browser.
-
-# Deploying on Heroku :
-
-## Prerequisites
-
-You will need the following things properly installed on your computer.
-
-Git
-Node.js (with NPM)
-Ember CLI
-PhantomJS
-Running Locally
-
-````
-$ git clone https://github.com/fossasia/badgeyay
-$ cd badgeyay/frontend
-$ yarn install
-$ ember server
-````
-
-Your app should now be running on localhost:4200.
-
-## Deploying to Heroku
-
-````
-$ heroku create --buildpack https://codon-buildpacks.s3.amazonaws.com/buildpacks/heroku/emberjs.tgz
-$ git push heroku master
-$ heroku open
-````
-
-
-
-## Further Reading / Useful Links
-
-* [Heroku Ember.js Buildpack](https://github.com/heroku/heroku-buildpack-emberjs)
-* [ember.js](https://emberjs.com/)
-* [ember-cli](https://ember-cli.com/)
-* Development Browser Extensions
-  * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
-  * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
+[Installation instructions](/docs/frontend/installation/README.md)
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1 @@
--r api/requirements.txt
+-r backend/requirements.txt
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		-r api/requirements.txt
		-r backend/requirements.txt