/quickflix-frontend

Primary LanguageHTML

Purpose

Web interface to allow user search for results of movie comments

Development Environment Setup

=== 0. install Python 2

  1. $ cd ProjectFolder
  2. Follow this link to create an isolated python virtual evnviroment. note the folder should be venv.
    • On OS X and Linux: $ . venv/bin/activate.
    • ON Windows: $ v-env\scripts\activate.
  4. Before proceed to next step, make sure you will see (ENV) in your shell
  5. $ pip install -r requirements.txt to install all required packages.

Database Setup

=== 0. Download MongoDB community server

  1. Follow this guide to setup & run mongoDb locally

Dependency

===

  • Enviroment Isolator: Virtualenv
  • Framework: Flask==0.10.1
  • Database: MongoDB
  • Others:
    • pymongo==3.0.1
    • PyYaml==3.11
    • Requests==2.9.1
    • WerkZeug==0.10.4
    • Jinja2==2.7.3

Coding Convention

===

JUST BE CONSISTENT!

#####Comments

  1. inline & block comment: start with # Number Sign.
  2. docstrings: surround by ''' ''' or """ """.

#####Naming

  1. function_name: lowercase, with words separated by underscores.
  2. variableName: start with lower case.
  3. CONSTANT_NAME: all capital letters with words underscores separated by underscores.