🚀 meta information on the Dojo 2 project
Latest commit 1c739ba Dec 13, 2016 @dylans dylans committed on GitHub add LICENSE file (#126)

README.md

dojo-meta

Join the chat at https://gitter.im/dojo/dojo2

This repository contains information regarding Dojo 2 that crosses package boundaries.

Guidelines and Style Guide

There are several documents that are relevent for contributing to Dojo 2.

Dependent Technologies

While Dojo 2 tries to provide a holistic set of tools to build web applications, there are several key technologies where we feel that Dojo 2 would be better integrating and building upon versus building from the ground up.

In order to ensure that Dojo 2 is a solid set of JavaScript tools and libraries, Dojo 2 is built on TypeScript. This provides us with structural design time typing as well as an effective way to communicate the intent of the Dojo 2 APIs. It also provides us the ability to adopt ES6+ syntax features but make distributables that will be backwards compatible to the target browsers for Dojo 2.

In addition, there are some core runtime technologies that parts of Dojo 2 are built on:

Packages

There are several packages that makeup the Dojo 2 platform:

  • dojo/actions - A command like library for Dojo 2 applications
  • dojo/app - An application framework for Dojo 2
  • dojo/cli - Command Line Tooling for Dojo 2 Applications
  • dojo/compose - A mixin/trait based composition library
  • dojo/core - The foundational code of the Dojo 2 platform
  • dojo/dataviz - A data vizualization library for Dojo 2
  • dojo/dom - A set of APIs for manipulating the DOM
  • dojo/has - A feature detection library
  • dojo/interfaces - Common interfaces and types for Dojo 2
  • dojo/i18n - A set of internationalization tooling
  • dojo/loader - A TypeScript based AMD loader
  • dojo/routing - A routing service to build web applications with
  • dojo/shim - Modules that provide fills of ES6+ functionality
  • dojo/stores - Data stores, quertying, transformation and materialization library
  • dojo/streams - WHATWG Streams implementation
  • dojo/widgets - A set of rich UI elements

We also have packages that are still in their planning stages and as such might not be part of the initial Dojo 2 release.

  • dojo/crypto - A set of libraries to deal with cryptography

We have deprecated a package:

  • dojo/parser - A HTML document parser for instantiating objects declaratively - This is deprecated in lieu of functionality provided by dojo/app.

Examples

We have added a repository of examples which have been built on Dojo 2. Those examples are available in the dojo/examples repository.

Support Packages

There are several packages which are designed to support the Dojo 2 platform:

These packages are aimed at Dojo 2 contributors rather than Dojo 2 end users.

Status

The following tables contain status information for the packages:

Package CI Status Code Coverage npm Stage Maintainer
dojo/actions Build Status codecov.io npm version Alpha
dojo/app Build Status codecov.io npm version Alpha
dojo/cli Build Status codecov.io npm version Alpha @Tomdye
dojo/compose Build Status codecov.io npm version Beta @maier49
dojo/core Build Status codecov.io npm version Alpha
dojo/dataviz Build Status Prototype
dojo/dom Build Status codecov.io npm version Beta
dojo/has Build Status codecov.io npm version Beta @kitsonk
dojo/interfaces Build Status Prototype
dojo/i18n Build Status codecov.io npm version Alpha @mwistrand
dojo/loader Build Status codecov.io npm version Beta
dojo/routing Build Status codecov.io npm version Alpha
dojo/shim Build Status codecov.io npm version Beta @kitsonk
dojo/stores Build Status codecov.io npm version Alpha @maier49
dojo/streams Build Status codecov.io npm version Alpha @rorticus
dojo/widgets Build Status codecov.io npm version Alpha @kitsonk

Example app packages

Package CI Status Code Coverage npm Stage Maintainer
dojo/examples Build Status codecov.io

CLI Packages

The dojo/cli will provide extensible functionality via a variety of packages that can be plugged into the CLI.

Package CI Status Code Coverage npm Stage Maintainer
dojo/cli-build Build Status codecov.io npm version Prototype
dojo/cli-create-app Build Status codecov.io npm version Alpha
dojo/cli-css-typings Build Status codecov.io npm version Alpha

Internal packages

Package CI Status Code Coverage npm Stage Maintainer
dojo/grunt-dojo2 Build Status codecov.io npm version Beta

Deprecated/proposed packages

Package CI Status Code Coverage npm Stage Maintainer
dojo/crypto Proposal
dojo/parser Deprecated