Kontent.ai Kickstart Sample React App

This repository contains the solution for the Kontent.ai Kickstart Sample React App. It serves as a learning resource for those starting new projects with Kontent.ai, providing a foundational template to build upon.

If you'd like to explore a fully set up Kontent.ai project, you can import content from one of the backups located in the ./scripts/backups folder.

npm run model:import --filename="<path-to-the-script>"

Contributing

How to Contribute

• Report Issues: Use the GitHub Issues to report bugs or request features.
• Fork the Repository: Create a personal fork of the repository on GitHub.
• Create a Feature Branch: Use a descriptive name for your branch.
• Submit a Pull Request: Submit your changes for review.

Please read our Contributing Guidelines for more details.

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Getting Started with Development

• Run npm ci to install packages.
• Create a .env file from .env.template and fill out all necessary variables.
• Run npm run dev to run the application in developer mode.

Regenerating model

After updating the Kickstart application's content model, the TypeScript models must also be regenerated. We've provided a script to automate this process using the Kontent.ai Model Generator.

npm run model:generate

Note

Ensure that the .env file contains the VITE_ENVIRONMENT_ID and VITE_MANAGEMENT_API_KEY variables for proper model generation.

License

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

---

Support

If you have any questions or need assistance, please reach out:

• Kontent.ai Support: Contact Support

---

Additional Resources

• Kontent.ai Official Documentation: Learn more about Kontent.ai

---