Changes from Version 1 of ntjGuidelines

Show
Ignore:
Author:
csa (IP: 141.52.64.104)
Timestamp:
04/05/14 04:34:53 (6 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ntjGuidelines

    v0 v1  
     1= Adei2 Proposal = 
     2This article only serves as proposal. These are not yet discussed in the group and may be subjected to changes. The final draft should be documented at [http://adei.info/adei/wiki/adei2Concepts Adei Concepts]. 
     3 
     4---- 
     5 
     6= Backend = 
     7 
     8 * [http://www.vagrantup.com/ Vagrant] - this is somewhat like a virtual machine, it is useful in a collaborative software project, where everybody is developing on the same platform, regardless of their OS. 
     9 * Web frameworks 
     10  * Python - [https://www.djangoproject.com/ Django], [http://www.tornadoweb.org/en/stable/ TornadoWeb]. (MVC Structure) 
     11  * Test - Unittest or Nosetests 
     12 * Websocket (I have no prior experience on this, but this might solve our huge data loading problem) 
     13 
     14---- 
     15 
     16= Frontend = 
     17  
     18 * HTML5 + CSS3 
     19 * Responsive design - this can be achived using CSS media queries. 
     20 * [http://backbonejs.org/ Backbone JS] - MVC Structure 
     21 * [http://requirejs.org/ Require JS] - module loader, this will speed up the script loading performance during production deployment. 
     22 * [http://bower.io/ Bower] - package manager 
     23 * Test - [http://pivotal.github.io/jasmine/ Jasmine], apparently this is not a TDD, but a BDD. This test framework has a good momentum and might be a good fit. 
     24 * CSS preprocessing - [http://sass-lang.com/ SASS] 
     25   
     26---- 
     27 
     28= Best Practice = 
     29 
     30 * Test Driven Development (Backend + Frontend) - if we have reliable tests, then we can implement a continuos integration (CI) later. 
     31 * Git 
     32 * [http://semver.org/ Semantic Versioning] 
     33 * [http://en.wikipedia.org/wiki/Representational_state_transfer RESTful] 
     34 
     35---- 
     36 
     37= Collaborative Tool = 
     38 
     39 * [https://www.atlassian.com/ Atlassian] - We need confluence (Documentation), Jira (Issue Tracking) and Stash (Repository). Apparently they offer educational license, free for up to 10 users. This is an alternative to trac. Just have a look. 
     40 
     41---- 
     42 
     43 OS:: 
     44   Operating System 
     45 MVC:: 
     46   Model View Controller 
     47 JS:: 
     48   Javascript 
     49 TDD:: 
     50   Test Driven Development 
     51 BDD:: 
     52   Behaviour Driven Development 
     53 RESTful::  
     54   Representational state transfer, in short, the HTTP request from the client tells which API from the server to be used and the Data (JSON) will determines which response to be returned. This way, the relationship between the server and the client will be completely isolated.