Bring on the code!
You can recursively clone and initialize all of toolkit’s submodules with a single git command.
To get the code, run:
git clone git://github.com/toolkitchen/toolkit.git --recursive
This creates a
toolkit/ folder with the following top-level files and folders:
- platform/ — Submodule which contains the platform shims and polyfills.
- test/ — Test cases.
- toolkit.js — The Toolkit kernel
You will also want the samples in
tookit-ui. To check this repo, run:
git clone git://github.com/toolkitchen/toolkit-ui.git --recursive
More on repository structure is below.
Test your environment
To check that your development environment is ready, start a local web server and run one of the included sample projects:
- Start a local web server in the folder where you have
- In your browser, navigate to http://localhost/toolkit-ui/workbench/menu.html, or whichever port you started the server on. You should see a menu of items, as shown below.
See Branching Workflow.
Updating Toolkitchen submodules
Periodically, we will update the projects’ submodules on GitHub. To update your local copy’s submodules, run the following command from the the repository’s folder:
git submodule update --init --recursive
The entirety of the Toolkitchen is composed of a number of Git
repositories. Most are included as submodules in the main
However, understanding the various pieces will help you navigate the codebase.
We have factored our repositories into atomic chunks, and then created integration repositories to bring them together again. For example, the following repositories may be useful individually:
Other repositories aggregate these individual repositories (as submodules) into useful combinations:
Each new web platform feature has a corresponding polyfill repository. The reasoning for this is two-fold:
- make the polyfills work across all modern browsers
- each polyfill can stand on its own and be used à la carte in projects.
platform repository references each of the polyfills as submodules, and contains integration tests, loader, and build tools for the amalgamated polyfills.
See Tooling Strategy for information.
If you want to see the development activity, checkout the master branch directly:
git clone -b master https://github.com/toolkitchen/toolkit.git --recursive
Remember: If you don't specify master, you'll get the stable branch by default. See Branching Workflow for more info.
- elements/ —
g-*custom element definitions.
- workbench/ — demos of using the Toolkit components in