Indie Kit DocumentationInstallation
Learn how to install the Indie Kit on your local machine and get started
Hello! Let's install the Indie Kit on your local machine to build your SaaS. 🚀
Here's the quick overview of the installation process. Follow along to get your app up and running.
Start a local server
- The first thing you need to do is to clone the repo.
git clone https://github.com/Indie-Kit/indie-kitFor B2B Kit, you can clone the repo from here:
git clone https://github.com/Indie-Kit/b2b-boilerplate
- Install
pnpmbecause pnpm is faster than npm. (if not done already)
npm install -g pnpm- Run
pnpm installto install the dependencies.
pnpm install- Run
pnpm devto start the development server.
pnpm dev-
Open the browser and go to
http://localhost:3000to see the app. -
Remove origin by running
git remote remove originto reset the repository so that you can push your changes to your own repository.
NextJS project structure
/src/app
This is a main folder where you will be working on your app.
/src/components
This folder contains all the components for your app.
/src/lib
This folder contains all the lib files, i.e. utils, hooks, etc. for your app.
/src/db
This folder contains all the database files for your app.
/src/emails
This folder contains all the email templates for your app.
/src/app/api
This folder contains all the api routes for your app.
Read more about the NextJS project structure here
Config.ts file
File /src/lib/config.ts contains all the configuration for your app. Please go through it and make changes as per your requirement.
Environment variables
File .env contains all the environment variables for your app. Please go through it and make changes as per your requirement.
Following environment files are supported:
.env- This file is common for all the environments. (Pushed to the repo).env.local- This file is used for local development. (Not pushed to the repo).env.production- This file is used for production environment. (Pushed to the repo)
Now go ahead and Follow the tutorial to launch your app