<div align="center" style="border-bottom: none"> <a href="https://kottster.app"><picture> <source media="(prefers-color-scheme: dark)" srcset="https://kottster.app/_next/image?url=%2Flogoline-white.png&w=256&q=75"> <source media="(prefers-color-scheme: light)" srcset="https://kottster.app/_next/image?url=%2Flogoline.png&w=256&q=75"> <img alt="Kottster logo" src="https://kottster.app/_next/image?url=%2Flogoline.png&w=256&q=75" width="140" /> </picture></a> </div> <div align="center">

Instant admin panel for your app

Get a custom Node.js admin panel. Create pages to view and manage data in your database tables, <br /> compose dashboards, or build fully custom pages. Secure, self-hosted, and easy to set up.

</div> <div align="center">

</div> <div align="center">

Get Started • Live Demo • Our Website • Docs

</div>

---

Getting started

To create a new project, run:

npx @kottster/cli@latest new

Make sure you have Node.js (v20 or above) installed on your system.

Alternatively, you can use Docker to run Kottster. For more details, check out the Docker Quickstart.

Next steps

1. Inside your project, run the app locally:

npm run dev

This will run the app locally in development mode. You can access it at http://localhost:5480.

2. Create an account.

After running the project, you'll need to log in to your account or create a new one.

3. Connect the app to your database.

4. Start building your app:

• Add pages for viewing and managing data in your database table.
• Or, build fully custom pages from scratch (dashboards, charts, forms, etc.).

5. Deploy your app when it's ready.

Resources

• Docs
  • Quickstart
  • Quickstart with Docker
  • Tutorial (5 min)
  • Deploying

Contribute

We welcome feedback and contributions!

• 🐛 Report a bug
• 💡 Suggest a feature
• 📚 Improve the docs

See CONTRIBUTING.md for guidelines.

Need Help?

• 💬 Join our Discord
• 📬 Contact us
• ✉️ team@kottster.app

License

Kottster is licensed under the terms of Apache License 2.0.