🏝️ Islandy Docs

Create a project

Create a new Islandy project by running the Islandy project creation tool. This scaffolds out the various files and folders a Islandy project needs.

New Islandy projects can be created by using the Islandy project creation tool. It will scaffold out a new project to get you started.

To create a new project, run:

$ mkdir my-islandy-app && cd my-islandy-app
$ npm create islandy@latest

This will scaffold out the new project containing some files and directories. There are files and folders that are strictly necessary to run a Islandy project:

Two important folders are also created that contain your routes and islands respectively:

Also a components/ folder is created that contains the server components files.

Finally a public/ folder is created that contains static files that are automatically served "as is".