• Seán Hargadon
• Jasmine Talukder
• Paddy Healy
• Patrick Hayes
• Luke Grehan

• Ubuntu 14.04

• Python 3.0
• Flask 0.10.1
• Ace editor (https://github.com/ajaxorg/ace)

git clone https://github.com/seanlth/CS4098.git
cd CS4098
make install

make run

• Open localhost:8000 in a browser for editor
• Open localhost:8000/login in a browser for login page
• Open localhost:8000/signUp in a browser for sign up page
• Open localhost:8000/diagram in a browser for the in-progress diagram page

##Release Two ##Features

• On localhost:8000/login
  • Third party authentication
• On localhost:8000/diagram
  • boxes arrows
  • enhanced agents
  • syntax enforcement
  • pml generator
  • basic pml display
  • resource flow (under flow lines in navbar, untested because it is purely visual and transparent to the browser)
  • analysis coloured action (under action colour in navbar, untested because it is purely visual and transparent to the browser)
  • agent colored actions (under action colour in navbar, untested because it is purely visual and transparent to the browser)
  • swim lanes (under flow lines in navbar, untested because it is purely visual and transparent to the browser, with your permission this is a similar layout to resource flow)

##Testing Release 2 open two terminals to the project directory. In one, run the server as shown, in the other run "env/bin/python3 seleniumTests/test.py" this is because "make test" causes an error saying env/bin/python3 is already in use. As noted above some features could not be automatically tested, to help with this, the test framework will stop on a diagram near the beginning so you can view the action colours/flow lines by selecting them from the navbar.

##Release One below

• On localhost:8000
  • Syntax Highlighting
  • Code editor
  • Keybinding Emulation
  • Code Completion
  • Syntax Analysis
  • Error Highlighting
  • File Save (must be logged in)
  • File Upload(must be logged in)
  • File Open (must be logged in)
• On localhost:8000/login and localhost:8000/signup
  • Email Authentification
• On localhost:8000/diagram
  • Boxes and Arrows
  • Scripts
  • Resouces (simple)
  • Agents (simple)
  • PML Generation
  • Analysis Coloured Actions

##Testing Instructions:

1. For many of the features available on localhost:8000 testing can be donw without signing in, Syntax highlighting
   and code completion are automaticically available with the latter being activated by pressing Tab or Enter while the
   popup is displayed. Keybinding emulation is selectable by using the Binding drop-down at the top of the page.
   File save, upload and open are all available under the File drop-down and you may be prompted to sign in if you have
   not done so.

2. Email authentication may be tested on either of pages listed /signup to create an account and /login to access it later.
   There are also links to /login on the main editor page.

3. Boxes and arrows can be tested on localhost:8000. Clicking on a (+) node allows you to add an action, branch,
   selection or iteration. For any of these except iteration, you have the option of clicking a bright green node,
   folding all the actions in between into the control structure or choosing the dark green node you already clicked
   on, creating a control structure with one new node. Red (+) nodes are invalid selections. You can change the names
   of these control structures with the [...] displayed beside the name which will create a prompt. The various parameters
   of an action can be altered using a form displayed when you click on one. The generate PML button will open a new
   tab/window with the editor open to PML generated based on your diagram. If the diagram becomes larger than the screen
   scrolling is done by clicking and dragging the mouse or by using the arrow keys. Choosing analysis from the Action Colour drop-down changes the colour depending on each actions requirements and provisions. [Dialog pop-ups are integral please do not disable the page from creating them.]

4. There are also some smoke tests available by running "make test". (On clean machines, run twice as there may be errors
   reported erroneously.)