README.md

Syria Right Now

A warning system for civilians amidst the Syrian Civil War

Project Status

Branch	Integration	Code Quality	Test Coverage
Master	not configured	not configured	not configured

Up Next

• Tests
• Pull data from Facebook
• Pull data from YouTube
• Extract location data (or use known location associated with account)
• Live map of Syria
• Add symbols based on keywords

Installation

• Ensure you have Python 2.7.9 and Pip installed.
  • On OSX, you can use HomeBrew

  brew install python
  

  • On Windows, download and install from python.org
• Ensure you have VirtualEnv installed

pip install virtualenv

• Clone the repository

git clone [email protected]:robot-overlord/syriarightnow.git

• Change into project root directory

cd syriarightnow

• Load up Virtual Env

virtualenv venv
source venv/bin/activate

• Install dependencies

pip install -r requirements.txt

• Copy .env.example and rename as .env and replace placeholder text with correct keys
• Start the Application

foreman start

Emoji tags for commits, PRs and comments

Platform	Symbol	Markdown
Linux/Android	🐧	:penguin:
OS X / iOS	🍎	:apple:
Windows / WindowsPhone	🏁	:checkered_flag:
BlackBerry	🍇	:grapes:

Device Size	Symbol	Markdown
Smartphone	📱	:iphone:
Tablet	📜	:scroll
Desktop	💻	:computer

Meaning	Symbol	Markdown
Idea	💡	:bulb:
Approval	👍	:+1:
Improving code format/structure	🎨	:art:
Improving performance	🐎	:racehorse:
Plugging memory leaks	🚱	:non-potable_water:
Writing docs	📝	:memo:
Bug Fix	🐛	:bug:
Removing code or files	🔥	:fire:
Fixing CI build	💚	:green_heart:
Adding tests	✅	:white_check_mark:
Security fix	🔒	:lock:
Upgrading dependencies	⬆️	:arrow_up:
Downgrading dependencies	⬇️	:arrow_down:
Fix linter warning	👕	:shirt:

Style Guides

Language	Guide
Python	Style Guide for Python Code
Sass (*.sass)	Essentially enforced by the syntax
Sass (*.scss)	Official Sass Styleguide
JavaScript	AirBnb
Git Commits	GitHub Guide
Pull Requests	Pull Requests