Getting Started

If you are interested in learning more about before trying it, read the Introduction.

If you are looking for configuration options, visit the configuration reference.

Try it Online ⚡️

Try it on StackBlitz

Installation 💿

Run the following command to create a new îles project.

pnpm create iles@next # or npm or yarn

The starter comes with Vue components and examples. Once you have installed all dependencies, give it a try by running npm run dev to start the development server.

Alternatively, add iles to your package.json in an existing project.

Usage 🚀

The iles executable provides the following commands:

  • iles dev: Starts the development server
  • iles build: Creates a production build of the site
  • iles preview: Preview the site after building

The following shortcuts are added by default when using the starter:

  "scripts": {
    "dev": "iles dev --open",
    "build": "iles build",
    "preview": "iles preview --open"
  },
  • npm run dev: Starts the development server
  • npm run build: Creates a production build of the site
  • npm run preview: Preview the site after building

Contact ✉️

Please visit GitHub Issues to report bugs you find, and GitHub Discussions to make feature requests, or to get help.

Show some love by ⭐️ starring the project if you find it useful!

News 🗞

Follow me or the official îles account on Twitter.