Skip to content

Latest commit

 

History

History
41 lines (34 loc) · 2.36 KB

deploy.md

File metadata and controls

41 lines (34 loc) · 2.36 KB
Raw

Deploying the Back-End

This document only contains how to deploy the back-end part of the app for running full app you have to deploy front end client also. You can find the front end client documentation here

Let's start with the basic steps on how to deploy this back-end API.

  • Install Python 2.7 on the system.
  • Open a terminal
  • run sudo apt-get update
  • run sudo apt-get install python-pip python-dev mysql-server libmysqlclient-dev. (use user: root and password: root. when installing mysql). You can change the user and password in /issue_parse/settings file.
  • run pip install -r requirements.txt
  • RELEX . . .
  • run python manage.py makemigration for making migrations.
  • run python manage.py migrate for migrating database.
  • run python manage.py createsuperuser to create a login password for logging in to admin panel.
  • For starting dev-server run python manage.py runserver.

  • You have to add repositories to the system or the app will not fetch issues and hence not work. And issues should follow the below template.

  • Admin view: To add repositories head to /admin/. Add repositories to the system, which you want to use. The system will fetch the issues of these repositories. you have to fill the username and repo name. Some user-repos that support the system are given below in the Supported Repositories section below, use these repos to start off.
  • Now you also have to setup worker server (alongside main server) for fetching github issues periodically (15 mins). For this follow these steps:
    • Open another terminal and run celery -A issue_parser beat -l info.
    • Open one more terminal and run celery -A issue_parser worker -l info
  • Now fire up a browser and go to /issues/ for seeing the json data of issues.

Supported Repositories

Use below data to add repos to the system via admin view.

  1. user: mozillacampusclubs, repo: issue_parser_backend
  2. user: mozillacampusclubs, repo: issue_parser_frontend
  3. user: razat249, repo: github-view

Issue Template

Issues should follow this template to be valid for the system:

Experience: Easyfix/Moderate/Senior
Expected-time: 1 week/2 months/etc.
Language: python/Javascript/others
Technology-stack: Django/React.js/others

## Description
Write your description here.