Scaffold the foundation for this project

[Glavin001]

Dependencies:

• Angular
• CoffeeScript
• jsPlumb

TODO:

• Use generator-angular with --coffee enabled.
  • Convert the JavaScript version of Gruntfile to CoffeeScript with http://js2coffee.org/
• Add jsplumb via Bower.
  • Unit Test verifying that jsplumb is loaded correctly when serving web app
• Write installation and usage instructions in README for other developers
  • Developer documentation, include coding conventions
    • See https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit
    • Developers should make issue branches and submit Pull Requests to be reviewed by the rest of the team. Using Pull Requests is what GitHub uses internally as well.
• Setup Travis CI
  • Travis CI badge
• Add Gitter Badge to README
  
• Generate CHANGELOG
  • Use https://github.com/btford/grunt-conventional-changelog
• Add repository field (and any others) to package.json

[MatKallada]

Thanks for using the generator, but I don't entirely think we should start scaffolding until we have fully agreed on our final plan and outline, since it is still a bit shaky now.

[Glavin001]

Well we know the technologies we intend on using (Angular, CoffeeScript, and JsPlumb), so that is unlikely to change (I believe @curtisko said it is up to us and we have discussed this at length already); and I put this in an issue branch for that very reason, if we end up going down this route, we can simply merge the Pull Request or reject it if not.

[Glavin001]

You do bring up a good point: up until now our discussion has been primarily via Facebook messages. I would like to get on record (in GitHub issues, possibly here?) the discussion (pros and cons) for our project foundation. If you have concerns about the foundation we have previously discussed, please start the discussion here :).

Once I am finished the scaffolding I will be submitting a Pull Request, which the team and collectively discuss and merge or reject. If we change direction again and it is rejected, then no harm done because I have still learned a little Angular and that is what it is all about: learning 👍.

[MatKallada]

Thanks for the update. Actually, I have already put everything on the Wiki and am guessing everything involving technical design to go there. I don't have really have any concerns, but there seems to be new things introduced here. Do you mind first noting your plans (maybe on the discussion section of the Wiki), so that the team can follow and stay on the same track 🎯 ?

Thanks ✌️

[Glavin001]

I don't have really have any concerns, but there seems to be new things introduced here.

I do not see anything new. What jumps out at you?

Do you mind first noting your plans (maybe on the Wiki), so that the team can follow and stay on the same track 🎯 ?

Absolutely! :)

Actually, I have already put everything on the Wiki and am guessing everything involving technical design to go there

I do not see anything in the project's wiki: https://github.com/mozilla/seasponge/wiki

I am guessing you mean the wiki here: https://wiki.mozilla.org/Security/Mentorships/MWoS/2014/online_threat_modeling_tool

How do I edit that? I am not setup there yet. A little help would be appreciated :).

The current Technical Design section of the wiki looks right to me.

To keep things simple - our application is completely client-side. Users may export their projects and save them onto their hard drives (and load them later on), or they may save their projects onto local storage.

Software	Description
Twitter Bootstrap	A front-end framework used for clean design
jsPlumb	A powerful HTML5 graph drawing toolkit
AngularJS	Client-side MVC Framework for single-page web applications

We are using Twitter Bootstrap, AngularJS, and jsPlumb, with CoffeeScript instead of JavaScript (as discussed via Facebook message).

I can add the CoffeeScript part in once I have access to the wiki. Will get on that now.

[Glavin001]

I was originally thinking we should Unit Test the inclusion of Bower dependencies, because @Frozenfire92 and I have had troubles in the past with dependencies not being included and the errors that it caused were cryptic and not obvious that a missing dependency was the cause.

However, it appears that the Grunt task for building the web app will actually notify the developer now when a dependency is not properly injected:

So that solves that!

Update: Actually this is an issue with the Bower version of jsPlumb, not having a main in it's bower.json file. See http://stackoverflow.com/a/23436755 for workaround.

[MatKallada]

I just added CoffeeScript to dependencies on the MozWiki. Also, you can request a Wiki account by clicking on the sidebar.

Side note: It might be a good idea to make use of the GitHub wiki as well - perhaps for infrastructure things. Any thoughts Glav?

-Mat

[Glavin001]

I would prefer the GitHub wiki. It is version controlled with Git, publically access, immediately modifiable by contributors, and I like the rendered wiki UI better (the Mozilla wiki does not provide links for header ideas, whereas GitHub markdown creates anchor links for headers, which are valuable for referencing).

The Mozilla wiki can be as it is now, and link to the GitHub wiki for more details 👍.

[Glavin001]

I just added CoffeeScript to dependencies on the MozWiki.

Thanks!

Also, you can request a Wiki account by clicking on the sidebar.

I requested a Wiki account here: https://wiki.mozilla.org/Special:RequestAccount

Although that'll take time and I'm not very interested in waiting right now :P. There is work to be done! Let's continue with the GitHub wiki from here on out.

Update: Wow, I just received confirmation of approval for MozillaWiki. That was fast! 😃

[Glavin001]

Looks like Travis CI was already setup with the generator. However, maybe I should say almost setup. There is a bug: Travis CI logs show:

Warning: Running "compass:dist" (compass) task
Warning: You need to have Ruby and Compass installed and in your system PATH for this task to > work. More info: https://github.com/gruntjs/grunt-contrib-compass� Use --force to continue.

I've encountered this many times before. Solution can be found here among many other places.