The scaffolding repo for Aurelia 2 used by the makes tool to create new Aurelia 2 projects.
First, ensure that you have Node.js v14 or above installed on your system. Next, using npx, a tool distributed as part of Node.js, we'll create a new Aurelia 2 app. At a command prompt, run the following command:
npx makes aureliaThis will cause npx to download the makes tool, along with the aurelia scaffold from this repo, which it will use to guide you through creating your project.
Use the preset picker to quickly choose a profile, including Lean Modern Frontend (TypeScript + Vite + Tailwind + Vitest + Storybook). When picking sample code, you can select Blank app for a clean, empty app shell (no demo markup) or use the minimal/router samples as before.
Plugin templates support Vite or Webpack. The Vite plugin build uses Vite's library mode (Rollup under the hood) and injects component CSS into the JS bundle so consumers don't need to import a separate CSS file. The dev-app still runs on the selected bundler for local testing.
There are some tests for this skeleton, setup in package.json. (totally not required by makes)
Unit tests for various "makes" files.
npm testE2E tests for skeletons.
GitHub Actions runs a subset of them for every PR or push to master.
# Do not run following directly. There are too many skeletons.
npm run test:e2eAlways target a subset of skeletons, use env variable TARGET_FEATURES.
# only test skeletons using webpack and typescript features.
npx cross-env TARGET_FEATURES=webpack,typescript npm run test:e2eIf you forked this repo, you can try your skeleton with:
# Try your master branch if your forked name is "new"
npx makes your_GitHub_name
# Try some branch or commit or tag
npx makes your_GitHub_name/forked_repo_name#some-branchMIT.