README.md

@dojo/framework

Dojo is a progressive framework for modern web applications built with TypeScript.

Visit us at dojo.io for documentation, tutorials, cookbooks, and other materials. This repository contains detailed information on the structure of Dojo, while dojo.io is focused on getting started with and learning Dojo.

Sub-packages within @dojo/framework

There are eight sub-packages that form the framework for building a Dojo application:

• dojo/core - The foundational code of the Dojo platform
• dojo/has - A feature detection library
• dojo/i18n - A set of internationalization tooling
• dojo/routing - A routing service to build web applications with
• dojo/shim - Modules that provide fills of ES6+ functionality
• dojo/stores - A lightweight state container
• dojo/widget-core - The foundation code of Dojo widgets
• dojo/testing - A set of modules to help with testing Dojo

External packages

We have additional packages within the Dojo ecosystem to aid in quickly and easily creating Dojo apps:

• dojo/interop - Interoperability with other frameworks (currently Dojo 1 Dijits and Redux)
• dojo/loader - A TypeScript based AMD loader
• dojo/themes - Collection of Dojo themes.
• dojo/widgets - A set of rich UI elements

Dojo CLI

• dojo/cli - Command Line Tooling for Dojo Applications
• dojo/cli-build-app - A CLI command for building Dojo applications
• dojo/cli-build-widget - A CLI command for building widgets
• dojo/cli-create-app - Command for creating application boilerplates
• dojo/cli-create-theme - Command for scaffolding a widget theme
• dojo/cli-create-widget - Command for creating a widget template and all associated boilerplate
• dojo/cli-test-intern - Command for testing projects with Intern

Support Packages

There are several packages which are designed to support the Dojo platform. Generally these packages are not directly used by end developers:

• dojo/dojo2-package-template - The standard template for Dojo packages, including build and packaging templates
• dojo/grunt-dojo2 - A set of Grunt tasks for use with Dojo packages.
• dojo/grunt-dojo2-extras - Additional tasks and code supporting continuous delivery with Dojo packages.
• dojo/scripts - A package of scripts to aid with Dojo package development.
• dojo/webpack-contrib - Specialized webpack loaders and plugins used by the Dojo toolchain.
• dojo/web-editor - A web editor that can run projects exported from cli-export-project

Version 2.x to 3.x Migration Guide

See the v3 migration guide for details on upgrading from version 2.x to version 3.x.

Examples

We have added a repository of examples which have been built on Dojo. Those examples are available in the dojo/examples repository and are live at dojo.github.io/examples.

Guidelines and Style Guide

There are several documents that are relevant for contributing to Dojo.

• Contributing Guidelines - Guidelines for contributing code (or documentation) to Dojo
• Code Of Conduct - Guidelines for participation in all Dojo OSS communities.
• Style Guide - The style guide for Dojo for packages that do not use prettier
• tslint.json - The configuration file tslint that is used to validate Dojo code against

Dependent Technologies

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

In order to ensure that Dojo is a solid set of JavaScript tools and libraries, Dojo 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 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.

Licensing information

© 2018 JS Foundation & contributors. New BSD license.