Installation

Install the theui-svelte component library in your project or start a new project with the boilerplate template. Install it to build fast and deliver faster.

Installation

Follow one of the two methods to install the component library:

  1. Github boilerplate.
  2. Manually installation.

Use Github Boilerplate

To install the starter template clone this Github repo from your terminal using the following commands, replacing my-app with your desired project name.

Clone from Github
# Clone the project
git clone https://github.com/mbparvezme/theui-svelte-starter.git my-app
# Navigate to the project directory
cd my-app
# Install node modules
npm install
# Run the application
npm run dev

Manual Installation

Easily add theui-svelte to your project via a GitHub boilerplate or manual installation. For manual setup:

  • Install Sveltekit with TailwindCSS and theui-svelte
  • Configure Tailwind CSS by updating the ./src/app.css file.

2.1 Install

Install SvelteKit
# Install Sveltekit
# Skip this step if you have already installed
npx sv create my-app
cd my-app
# Install node modules
npm install

# Install theui-svelte
npm install theui-svelte

2.2 Configuration

To integrate theui-svelte with your project, add the following lines to your ./src/app.css file:

./src/app.css
     @import 'tailwindcss';
+    @import 'theui-svelte/style';
+    @source "../node_modules/theui-svelte";

That's it! You're ready to start building your awesome project. Now, run your application with:

Install SvelteKit
# Run SvelteKit project
npm run dev