protocore-typescript-edition

Protocore-typescript-edition is special TypeScript implementation edition of Protocore project.

Supports

• Node.js v6.0.0 or above

List of npm/libs etc. that are used to build it

• jQuery - Used for DOM manipulation.
• Webpack - Used for module loader & bundler.
• Hasher & Crossroads - Used for application routing
• Signals - Used for pubsub events.
• Express - Used for local HTTP-server static serving.
• Mocha & Chai - Used for unit testing [Coming soon]
• JSHint, CSSLint, JSCS, LESS, JSON [Coming soon] & Handlebars templating

Installation

Assuming that Git is already installed & running:

git clone https://github.com/Protocore-UI/protocore-typescript-edition.git

Assuming that Node.js is already installed & running,

Install dependencies:

npm install

npm install -g webpack

Generate bundle file: (First command after installing dependencies)

npm run build

To start the development server:

npm start

Protocore Experiments

Protocore is an open source walking application skeleton for a typical unstructured JavaScript/jQuery web apps. You can use it to quickly bootstrap your unstructured JavaScript/jQuery web application projects.

protocore-webpack-edition is a special ECMAScript 6 + Webpack implementation edition of Protocore project.

generator-protocore is a Yeoman generator for Protocore. The tool will help to generate walking application skeleton for a typical unstructured JavaScript/jQuery web apps.

Protocore-cli is a command line generator for Protocore. This tool will help to generate a walking application skeleton for a typical unstructured JavaScript/jQuery web apps.

Server layer

The server side codebase resides in the server.js and config.js files. By default, the server layer is written in JavaScript (Node.js with Express 4.x) which can be configured and flexible to work with any server side scripting language like Java, PHP, ASP.NET or others. As client and server layer are seperate entity.

Client layer

The client side codebase resides in the src folder. This folder contains following subfolders.

/src
	+-- /stylesheets
		+--/css
		+--/less
			+--/common
			+--/base
			+--/layout
			+--/modules
			+--/state
			+--/theme
	+-- /assets
		+--/fonts
		+--/images
	+-- /apps
		+--/views
		+--/router
		+--/templates

Stylesheet layer

The codebase comes with LESS setup with a Scalable and Modular Architecture for CSS (SMACSS) approach. SMACSS is a way to examine your design process and as a way to fit those rigid frameworks into a flexible thought process. It is an attempt to document a consistent approach to site development when using CSS.

License

The MIT License (MIT)

Copyright (c) 2016 Ashwin Hegde