Skip to main content

​
Get started in three steps

This quickstart guide assumes that you already have Rust and Cargo up and running on your machine.
Look at this guide if you want to know how to setup Rust and Cargo on your machine.

​
Step 1: Install the kit-cli

Install the kit-cli on your machine via Cargo using the following command:
Terminal
cargo install kit-cli

​
Step 2: Create your project using kit-cli

Run the following command to create your project. Replace the todo-app with your project name
Terminal
kit new todo-app
The ineractive shell will ask some project specific questions like Project Name, Author etc. Answer all the questions and then the cli will generate the project files for you

​
Step 3: Run migrations

Before starting the server, run the database migrations to set up the users and sessions tables:
Terminal
cd todo-app
kit migrate

​
Step 4: Start the web server

Now start the web server using the kit serve command:
Terminal
kit serve
This will start the web server and in the terminal you will see the URL on which your web server is running. Go to the url and you will find your app up and running!

​
What’s Included

Your new Kit project comes with batteries included:
  • Authentication - Login, registration, and logout endpoints with session-based auth
  • Protected routes - Dashboard page that requires authentication
  • CSRF protection - Automatic protection against cross-site request forgery
  • Database migrations - Users and sessions tables ready to go
  • React/Inertia frontend - Pre-configured with TypeScript and Tailwind CSS
Visit /login to see the login page, or /register to create a new account.