nqthqn / wibi

Web Interaction Based Intervention

Note, this project is now privately held here.

wibi

Web Interaction Based Intervention

---

This application includes data models defined using django ORM. These models are revealed to the client via a REST API for consumption by an Angular Single Page Application (SPA). The SPA will reside within an in-app web browser. Some buttons will trigger certain actions within the app, such as video recording.

---

Installation

You should use virtualenvwrapper and pip.

You will need node and npm

1. Install backend requirements: pip install -r requirements.txt
2. Make an sqlite3 database for development ./manage.py syncdb
3. Dive into the Angular app cd project/static/wibi
4. Install frontend requirements: npm install && bower install (this will create app/bower_components and node_modules/)
5. Then go up a couple directories and ./manage.py runserver

Directory Layout

project/
├── static/                 Angular.js in here under wibi/
├── utils/                  helpful mixins, middleware etc.
└── project/
    ├── models.py           models --> REST API
    ├── serializers.py      For the django REST Framework
    ├── settings.py         Django settings
    ├── urls.py             catchall for Angular minus /api/ and /admin/
    ├── views.py            >> delivers index.html Angular app from dist/
    └── wsgi.py             server connection setup

Schema Design

Backend Docs

• Django REST
• Gunicorn
• Python Interface to Redis
• Markdown

Frontend Docs

• Angular API
• Bootstrap