Skip to content

Latest commit

 

History

History
75 lines (56 loc) · 2.24 KB

readme.md

File metadata and controls

75 lines (56 loc) · 2.24 KB
Raw

MeanTS

Before you begin

We recommend you read about the basic building blocks that assemble a CnnVis application:

  • MongoDB
  • Express
  • AngularJS 1.x (in the future, we are considering to use angular 2.x)
  • Node.js
  • Typescript

Prerequisites

  • Git
  • Node.js
  • MongoDB
  • Bower

Quick Install

  1. $ npm install -g typescript, typings, gulp
  2. $ npm install

Running Your Application

Run your application using gulp:

$ gulp

It will compile the source codes in ./src to the ./build folder in the project directory.

Useful commands:

check your installed packages with command: npm list -g --depth=0

File Structure

The folder structure is quite self-explanatory.

src

The src folder contains all the source code written in typescript. It contains ..

build

The build folder is where the .ts files are compiled (to .js) and stored.

public

The public folder contains all the static files you use in your application, this is where you store your front-end files.

  • dist the distribution folder is where your application compressed CSS and Javascript assets.
  • assets website theme assets
  • lib bower installed components

Application Files

  • server.js the main file (entry) of our application, where you initialize (start) the node.js application.
  • bower.json bower definition file, where you configure the front-end components you want to use.
  • gulpfile.js gulp definition file, where you define your gulp tasks.
  • package.json npm definition file, where you configure the backend modules you want to use.

Typescript Project File

  • tslint.json
  • typings.json
  • tsconfig.json

Hidden Configuration Files

  • .bowerrc bower configuration file, you use it to tell bower where to install your application components.
  • .csslintrc csslint configuration file, you use it to configure csslint special properties
  • .gitignore git ignore file, you use it to tell git what ignore in next commits

coding style guideline

Classes: CClassName Interfaces: IInterfaceName Methods: MethodName Data members: m_data Private data members: m_data_ Static data members: s_ Variables: myVar Global variables: g_globalVar Constants, Enumerations: AA_BB_CC