Skip to content

Getting started

A project in Ikasu is one website. There are three ways to start one:

  • From a template: a complete, made-up website to try Ikasu on.
  • From your own repository: the site you already have on GitHub, GitLab or another git host.
  • From files you upload: a folder, some files or a ZIP, for example a site you made with another tool.

Whichever you pick, you can edit and preview right away. Only shipping your changes needs a repository of your own, and you can link one later.

If you have no projects yet, the start page shows the templates straight away under Start your first project. Otherwise click New project and choose Start from a template.

Pick a card and click Use this template. Ikasu makes your own copy of that site and opens it. Nothing is published: the copy stays in Ikasu until you link your own repository.

Below the cards, Or start from another public repo takes the address of any public repository (starting with https://) as a starting point. It is copied, not connected: to work on your own site, use Bring your own repo instead.

Click New project, choose Bring your own repo and give the project a name.

  1. Click Connect GitHub or Connect GitLab.
  2. Confirm once on GitHub or GitLab.
  3. Back in Ikasu, pick the repository, or create a new, empty one. Then click Link this repo or Create and link.

Ikasu adds a deploy key to that one repository for you. After that, Ikasu keeps no access to your GitHub or GitLab account: the deploy key is its only way into the repository.

Enter the repository’s SSH address under Repo URL, for example git@git.example.com:you/site.git, and click Create project. Ikasu then shows a public key.

  1. Open your repository’s settings on your git host (not your personal account settings) and find Deploy keys.
  2. Add the key Ikasu shows, and turn on write access. On GitHub that is “Allow write access”, on GitLab “Grant write permissions to this key”. Without it, Ikasu can read your site but can’t ship changes back.
  3. Back in Ikasu, click Verify. When it says Key verified, you’re set.

How do I add this as a deploy key? under the key shows these steps for GitHub, GitLab and other hosts, with a link to the right settings page. If you can’t add it now, click I’ll add it later: the key stays in the project settings. A public repository can be read without the key, so you can start right away and add the key before your first ship.

Click New project and choose Upload files. Drag a folder, files or a ZIP into the box, or use Choose files or Choose a folder. Both the source of a site and a finished, built site work.

A single ZIP, such as a site you downloaded, is unpacked. If the ZIP itself is meant to be a file on your site, click Keep as a ZIP. Uploads can be up to 200 MB.

Like a template, an upload is your own copy in Ikasu until you link a repository.

Before the first session, Ikasu needs to know how to build your site:

  • Install command and Build command, one per line.
  • Build output dir: the folder the build writes the finished site to, such as dist. A site without a build uses ..

For a template from the cards, Ikasu fills these in, and for an upload whenever it recognizes the site. For your own repository or another public one, click Detect from repo and check what it found. If it can’t recognize the framework, ask whoever built the site which commands they use.

Then click Start session. Ikasu builds the site and shows the preview.

A project from a template or an upload works fully without a repository: you can edit it, preview it and download its files. To ship your changes, link a repository under Repository in the project settings, the same way as above.

The repository has to be empty, or hold only starter files such as a README, a licence or a .gitignore. Ikasu writes your site into it as its first commit, and keeps those starter files. A repository that already holds another site is refused.