Skip to content
Permalink
Browse files

adding documentation

  • Loading branch information...
cyriac committed Jul 15, 2016
1 parent cc8e91c commit 222f90e72d1e570264f9940b7a585b948eea8ef2
Showing with 55 additions and 35 deletions.
  1. +0 −32 INSTALL.md
  2. +26 −2 README.md
  3. +8 −0 docs/DEVELOPMENT.md
  4. +21 −0 docs/INSTALL.md
  5. BIN docs/images/banner.jpg
  6. +0 −1 requirements-dev.txt

This file was deleted.

Oops, something went wrong.
@@ -1,3 +1,27 @@
# Stormtrooper
![Stormtrooper](docs/images/banner.jpg)

> "You are stormtroopers. You are the keenest weapon in the Emperor's arsenal. Do not fail him. Do not fail me." ― ISB Commander Alecia Beck
Stormtrooper is a co-ordination system for tasks that require human intelligence.:woman: :man: :older_woman: :older_man: :man_with_turban: :man_with_gua_pi_mao: :person_with_blond_hair: :cop: :construction_worker:

# Features
## Authentication
- Works based on google-oauth2/google apps. Can potentially support anything all the supported by [python-social-auth](#)
- Abiltity to limit domains for signup

## Tasks
- Multiple questions can be created with just a csv upload
- Questions can have more than one hint to help the person find the right answer
- Answers can be computed based on either maximum occurance of an answer based or based on best of n logic
- Answers can be pre-determined choices or textual answers

## Plugins
- Support for processing user answers before calculating the right one. eg: https://google.com/ and google.com could be given same weightage


# Resources
- [Installation](./docs/INSTALL.md)
- How to use - Please check the [wiki](https://github.com/CompileInc/stormtrooper/wiki/)
- [Development](./docs/DEVELOPMENT.md)
- Need help? Open an [issue](https://github.com/CompileInc/stormtrooper/issues/) or give us a holler at <stormtrooper@compile.com>

> "You are stormtroopers. You are the keenest weapon in the Emperor's arsenal. Do not fail him. Do not fail me." ―ISB Commander Alecia Beck
@@ -0,0 +1,8 @@
## Docker

- Append ```localsettings.py``` with docker-specific settings (```docker-settings.py.sample```). ```cat stormtrooper/docker-settings.py >> stormtrooper/localsettings.py```
- Install docker
- ```pip install docker-compose```
- ```docker-compose up --build```
- ```docker exec stormtrooper_db_1 createdb -Upostgres stormtrooper```
- <kbd>Ctrl</kdb> + <kbd>C</kbd> and restart again with ```docker-compose up```
@@ -0,0 +1,21 @@
# Installation

## Requirements
- Python 2.7
- Postgres 9.4+
- Redis

## Database (postgres 9.4+)

CREATE DATABASE stormtrooper;
CREATE ROLE trooper PASSWORD 'trooper' LOGIN;
GRANT ALL PRIVILEGES ON DATABASE stormtrooper TO trooper;

## Python

pip install -r requirements.txt
pip install -r requirements-dev.txt # development
cd stormtrooper
cp stormtrooper/localsettings.py.sample stormtrooper/localsettings.py # Change your values appropriately
python manage.py migrate
python manage.py createsuperuser
BIN +63.5 KB docs/images/banner.jpg
Binary file not shown.
@@ -1,3 +1,2 @@
-r requirements.txt
django-seed==0.1.6

0 comments on commit 222f90e

Please sign in to comment.
You can’t perform that action at this time.