mdboop / app.producer Goto Github PK

     .--..--..--..--..--..--..--..--..--..--..--..--..--..--..--..--.
    / .. \.. \.. \.. \.. \.. \.. \.. \.. \.. \.. \.. \.. \.. \.. \.. \
    \ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/ /
     \/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /
     / /\/ /`' /`' /`' /`' /`' /`' /`' /`' /`' /`' /`' /`' /`' /\/ /\
    / /\ \/`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'\ \/\ \
    \ \/\ \                                                    /\ \/ /
     \/ /\ \                                                  / /\/ /
     / /\/ /               A UI for Showrunner                \ \/ /\
    / /\ \/                                                    \ \/\ \
    \ \/\ \               to make things better                /\ \/ /
     \/ /\ \                                                  / /\/ /
     / /\/ /                                                  \ \/ /\
    / /\ \/                                                    \ \/\ \
    \ \/\ \.--..--..--..--..--..--..--..--..--..--..--..--..--./\ \/ /
     \/ /\/ ../ ../ ../ ../ ../ ../ ../ ../ ../ ../ ../ ../ ../ /\/ /
     / /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\/ /\
    / /\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \/\ \
    \ `'\ `'\ `'\ `'\ `'\ `'\ `'\ `'\ `'\ `'\ `'\ `'\ `'\ `'\ `'\ `' /
     `--'`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'`--'

Staging: http://api.staging.hackreactor.com/producer/v0/

Node/Express + AngularJS + LevelDB

• npm start

• fork the repo
• git clone https://github.com/hackreactor-labs/app.producer.git
• npm install
• bower install
• touch .env from root directory
• update the .env file with personal Asana keys (follow instructions below)
• nodemon

These should be inside of the .env file:

• ASANA_API_KEY=YOUR_API_KEY
• WORKSPACE_ID=FROM_YOUR_ASANA_ACCOUNT
• PROJECT_ID=FROM_YOUR_ASANA_ACCOUNT
• ROLES_ID=FROM_YOUR_ASANA_ACCOUNT
• ASANA_ACCESS_TOKEN=YOUR_ACCESS_TOKEN
• EVENTS_URL=http://api.staging.hackreactor.com/choreographer/v0/metronome/events
• CHOREOGRAPHER_URL=http://api.staging.hackreactor.com/choreographer/v0
• CHOREOGRAPHER_SECRET=FROM_TEAMMATES
• PORT=8000

For local development, a Github Application will need to be registered. Follow these steps and add these additional variables to your .env file:

1. In github, go to Settings > Applications > Developer Applications > Register a new app
2. Get the client id and the client secret that are generated
3. add this as the callback url http://127.0.0.1:8000/auth/github/callback
4. add the following to your .env file

• **GITHUB_CLIENT_ID=**YOUR_CLIENT_ID
• **GITHUB_CLIENT_SECRET=**YOUR_CLIENT_SECRET
• **TEAM_NAME=**w-producer
• **ORG_NAME=**hackreactor-labs
• **GITHUB_CALLBACK_URL=**http://127.0.0.1:8000/auth/github/callback
• **USER_AGENT=**YOUR_USERNAME

For local development, a personal Asana account is needed. Once you have created an account, complete the following:

• go to your profile settings and click the 'Apps' tab
• create an API key and Personal Access Token
• create a new project; PROJECT_ID can be found in the url of the project: https://app.asana.com/0/{PROJECT_ID}/....
• create a new project to store a list of roles: ROLES_ID can be found in the url of the roles project: https://app.asana.com/0/{ROLES_ID}/....
• WORKSPACE_ID can be found here: https://app.asana.com/api/1.0/workspaces (be sure you are logged into your account) For more detailed instructions, see the Asana documentation

• npm test

dependencies

• Node
• app-boot
• node-asana
• body-parser
• dotenv
• express
• morgan
• q
• request
• aws-sdk
• levelup
• leveldown
• s3
• node-uuid

dev-dependencies

• bower
• jasmine
• jasmine-core
• jasmine-node
• karma
• karma-chrome-launcher
• karma-jasmine
• karma-phantomjs-launcher
• karma-spec-reporter
• phantomjs

• Choreographer: A service containing three services: Melody, Metronome, and Choreographer. The Choreographer sub-service is responsible for addings tasks to Asana to the appropriate person when a template is triggered.
• Event: A model of a specification for when a procedure should happen. Takes a title, an optional cron job, and an optional description (Ex. '9am on the 3rd of every month'). Events can also be Hack Reactor-specific cyclical events, which have the form 'WXDX' where 'WX' is the week and DX is the day. Note: events are not associated with specific procedures upon creation; they are only associated with procedures when a template is made.
• Melody: A sub-service of Choreographer responsible for Hack Reactor-specific cyclical events, which take the form of ('W4D2');
• Metronome: A sub-service of Choreographer responsible for cron events. Has its own database, and sends triggers for templates to the Choreographer sub-service whenever cron events fire.
• Procedure: A model of a task to be done. Takes a title and an optional description (Ex. 'Take out the trash').
• Producer: A service and UI that allows users to:
  • create procedures
  • create events
  • create templates
  • trigger templates
• Role: A model that functions similarly to a job title in that it captures that one person should have various responsibilities. Those responsibilities are procedures and are linked to roles and events with templates (Ex. 'Space Ops Associate').
• Soundboard: A page of Producer that allows a user to trigger a template manually.
• Template: A model that links roles, procedures, and events together (Ex. 'Space Ops associate should take out the trash at 9am on the 3rd of every month'). Templates submitted to the Choreographer UI are sent to Asana. Choreographer then reads templates from Asana and uses Metronome to trigger templates, which assigns that task at the appropriate time to the person in that role in Asana.