Skip to content
Branch: dev
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.docker
.tx
amara-assets @ 579bcdb
amara-enterprise @ 70a96d8
apps
babelsubs @ 1050588
bin
closure
codeship
css-compression
deploy
docker-dev/mysql/conf.d
docs
guitests
libs
locale
media
pykss @ f393d7b
static
templates
unilangs @ 02619bd
utils
.ctags
.dockerignore
.ffignore
.gitignore
.gitmodules
.ignore
.jshintrc
.kick
COPYING
Dockerfile
README.markdown
README.transifex
checkout-submodules
codeship-services.yml
codeship-steps.yml
creds.encrypted
crossdomain_views.py
dev_settings.py
dev_settings_test.py
docker-compose.yml
manage.py
middleware.py
optionalapps.py
schema.xml
settings.py
startup.py
task_settings.py
testacular.conf.js
unisubs_settings.py
urls.py
views.py

README.markdown

This repository is the code for the Amara project.

The full documentation can be found at http://amara.readthedocs.org/en/latest/index.html

Quick Start

Amara uses Docker. For ease of development, we use the docker-compose tool to have a full, production like, local dev environment.

  1. Git clone the repository:

     git clone git://github.com/pculture/unisubs.git unisubs
    

    Now the entire project will be in the unisubs directory.

  2. Get submodules. There are two cases here:

    • For non-pcf employees, use the ./checkout-submodules public
    • For PCF employees and others with access to our private repositories, use the ./checkout-submodules all

Note: for either case, make sure that you have SSH access setup for github. (https://help.github.com/articles/connecting-to-github-with-ssh/)

  1. Install docker-compose (http://docs.docker.com/compose/install/)

  2. Build the Amara docker image:

     bin/dev build
    
  3. Configure Database:

     bin/dev dbreset
    
  4. Start Amara Containers:

     bin/dev up
    
  5. Add unisubs.example.com to your hosts file, pointing at 127.0.0.1. This is necessary for Twitter and Facebook oauth to work correctly.

    You can access the site at http://unisubs.example.com:8000.

To see services logs, run docker-compose logs <service> i.e. docker-compose logs worker

Testing

To run the test suite:

    bin/dev test

Dev Notes

To run a single manage.py command:

    bin/dev manage <command>

To see running services:

    docker-compose ps

To stop and remove all containers:

    docker-compose kill ; docker-compose rm

To view logs from a service:

    docker-compose logs <service>

To create an admin user:

    bin/dev manage createsuperuser

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.