kottster

Kottster

Instant admin panel for your project ⚡

Website • Docs • Pricing

Getting started

To create a new project, run:

npx @kottster/cli new

Make sure you have Node.js version 20 or above installed on your system.

Next steps

1. Inside your project, run the app locally:

npm run dev

2. Create an account.

After running the project, you'll need to log in to your account or create a new one. Once logged in, create an app by specifying its name.

3. Connect the app to your database:

# PostgreSQL
npm run dev:add-data-source postgres

# MySQL
npm run dev:add-data-source mysql

# MariaDB
npm run dev:add-data-source mariadb

After running the command, the new file will be created inside app/.server/data-sources/ folder. Edit the file to configure the connection to your database, and restart the server.

4. Start building your app:

• Use our builder to instantly generate pages based on your database.
• Or, create and customize pages on your own.

5. Deploy your app to production when it's ready.

Resources

• Docs
  • Quickstart
  • Build and deploy

Need Help?

• Contact us
• [email protected]

License

Kottster is licensed under the terms of Apache License 2.0.