Installation

Introduction

KianKit is setup like a regular SvelteKit app with some added folders, and modified routing.

Structure

src/
├── lib/ # Library files containing reusable components, layouts, schemas, server-side utilities, and helper functions.
│   ├── components/ # Components used across the application.
│   ├── layouts/ # Layouts that define the structure for different pages or sections.
│   ├── schemas/ # Schemas for data validation and structure.
│   ├── server/ # Server-side code and utilities.
│   └── utils.js # General utility functions used across the project.
├── routes/ # Route definitions and corresponding page components for the application.
│   ├── (app)/ # Application-specific routes, likely for the main user experience.
│   ├── (auth)/ # Authentication-related routes, such as login and signup.
│   ├── (marketing)/ # Marketing pages, possibly for landing pages or promotional content.
│   └── sitemap.xml/ # Sitemap directory, likely for generating a sitemap.xml for SEO.
static/ # Static files like images, fonts, or other assets that don’t change frequently.

Prerequisites

Before you begin, ensure you have met the following requirements:

You have pNPM installed on your machine.
Create a Supabase project.

You should be good to go!

Clone the repository

There are two ways to get KianKit onto your machine, it all comes down to your choice.

You can fork KianKit and then clone down your own version of it.

# After forking the repository
git clone --depth 1 https://github.com/<username>/kiankit <your-project-name>

You can clone the repository directly.

# Clone the repository
git clone --depth 1 https://github.com/cowboycodr/kiankit <your-project-name>

Install dependencies

The next step is to install all of the required dependencies for KianKit, we use pnpm as the package manager.

# Navigate to the project directory
cd <your-project-name>

# Install dependencies
pnpm install

Setup

You will need to rename the .env.example to .env and fill in the environment variables with your Supabase project’s variables.

Email configuration

To ensure email & password auth works properly it is recommened to set up a proper SMTP server with Supabase. You can learn more about that here. I recommend using Resend for this.

OAuth

You must follow the following guides to get OAuth up and running:

Running the project

Now that your project is set up, you can run the project!

pnpm run dev

Introduction Development

​Introduction

​Structure

​Prerequisites

​Installation

​Setup

​Email configuration

​OAuth

​Running the project