Skip to content

Repository containing starters templates to be used within Kodu

License

Notifications You must be signed in to change notification settings

kodu-ai/starters

Repository files navigation

Kodu AI Starters

Welcome to the Kodu AI Starters repository! This collection contains starter templates designed to kickstart your projects within the Kodu ecosystem.

🚀 Getting Started

Our starters are designed to help you begin your projects quickly and efficiently. Each starter comes with a pre-configured setup tailored for specific use cases.

📚 Available Starters

  • NextJS Project
  • Python Script
  • Vite React Project
  • Remix TypeScript Project

For a complete list and details of available starters, check out our starter catalog.

🛠 How to Use a Starter

  1. Browse the available starters in our catalog
  2. Choose the starter that best fits your project needs
  3. Use the Kodu CLI or UI to initialize your project with the chosen starter

🌟 Contributing

We welcome contributions to our starter collection! Here's how you can add a new starter:

  1. Fork this repository
  2. Create a new branch for your starter
  3. Add your starter files in a new directory
  4. Create a pull request with your changes

Pull Request Guidelines

When submitting a new starter, please ensure your pull request adheres to the following schema:

{
  "title": "Your Starter Name",
  "description": "A brief description of your starter",
  "repo": "https://github.com/kodu-ai/starters/tree/main/your-starter-name",
  "creator": "your name",
  "isOfficial": false
}

Adding a .kodu File

To enhance the Kodu experience for your starter, include a .kodu file in your project root. This file should contain natural text that will be injected into the system prompt by default. You can include:

  • Special instructions for using your starter
  • Best practices for the technology stack
  • Any other relevant information for users

Example .kodu file content:

This Next.js starter is optimized for building scalable web applications.
Remember to follow React best practices and utilize Next.js features like
server-side rendering and API routes for optimal performance.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Support

If you have any questions or need assistance, please open an issue or contact our support team.

Happy coding with Kodu AI Starters! 🎉

About

Repository containing starters templates to be used within Kodu

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published