Get started

Take a few minutes to install Tikui and to create your first component if you want. We will guide you step by step. You'll see, it's very easy to do.

Intalling Tikui

Take a few minutes to install Tikui. We will guide you step by step. You'll see, it's very easy to do.

Step 1: Install requirements

Make sure you have Node.js installed before setting up Tikui.

Then install Tikui CLI:

npm i -g @tikui/cli

Step 2: Generate your pattern library

The next command will generate my-pattern-library folder with a Tikui installation:

tikui generate my-pattern-library

Step 3: Install dependencies

Go to the root folder and install:

cd my-pattern-library
npm install

Step 4: Serve and code

While you're coding, run the application locally on localhost:3000.

npm run serve

You're now ready to code, please follow the instructions from the generated README.md to create your first component.

Step 5: Build

After you add your styles, you may need to build your assets statically using:

npm run build

Now you are able to expose your assets on your favourite server or publish them as a Node.js dependency.