https://github.com/kontent-ai/kickstart-react-app
The Kontent.ai Kickstart React App is a sample application designed to facilitate learning of Kontent.ai.
https://github.com/kontent-ai/kickstart-react-app
headless headless-cms jumpstart kickstart kontent-ai kontent-react react
Last synced: 9 months ago
JSON representation
The Kontent.ai Kickstart React App is a sample application designed to facilitate learning of Kontent.ai.
- Host: GitHub
- URL: https://github.com/kontent-ai/kickstart-react-app
- Owner: kontent-ai
- License: mit
- Created: 2024-10-24T11:14:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-04T10:32:27.000Z (9 months ago)
- Last Synced: 2025-09-04T12:30:17.816Z (9 months ago)
- Topics: headless, headless-cms, jumpstart, kickstart, kontent-ai, kontent-react, react
- Language: TypeScript
- Homepage: https://kickstart.sample.kontent.ai
- Size: 8.77 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Kontent.ai Kickstart Sample React App
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Discord][discord-shield]][discord-url]
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.
```bash
npm run model:import --filename=""
```
## Contributing
### How to Contribute
- **Report Issues**: Use the [GitHub Issues](https://github.com/kontent-ai/kickstart-react-app/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](CONTRIBUTING.md) for more details.
### Code of Conduct
This project adheres to a [Code of Conduct](https://github.com/kontent-ai/.github/blob/main/CODE_OF_CONDUCT.md). 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](https://github.com/kontent-ai/model-generator-js).
```bash
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](LICENSE) file for details.
---
## Support
If you have any questions or need assistance, please reach out:
- **Kontent.ai Support**: [Contact Support](https://kontent.ai/support/)
---
## Additional Resources
- **Kontent.ai Official Documentation**: [Learn more about Kontent.ai](https://kontent.ai/learn/)
---
[contributors-shield]: https://img.shields.io/github/contributors/kontent-ai/kickstart-react-app?style=for-the-badge
[contributors-url]: https://github.com/kontent-ai/kickstart-react-app/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/kontent-ai/kickstart-react-app.svg?style=for-the-badge
[forks-url]: https://github.com/kontent-ai/kickstart-react-app/network/members
[stars-shield]: https://img.shields.io/github/stars/kontent-ai/kickstart-react-app.svg?style=for-the-badge
[stars-url]: https://github.com/kontent-ai/kickstart-react-app/stargazers
[issues-shield]: https://img.shields.io/github/issues/kontent-ai/kickstart-react-app.svg?style=for-the-badge
[issues-url]: https://github.com/kontent-ai/kickstart-react-app/issues
[license-shield]: https://img.shields.io/github/license/kontent-ai/kickstart-react-app.svg?style=for-the-badge
[license-url]: https://github.com/kontent-ai/kickstart-react-app/blob/master/LICENSE.md
[discord-shield]: https://img.shields.io/discord/821885171984891914?color=%237289DA&label=Kontent.ai%20Discord&logo=discord&style=for-the-badge
[discord-url]: https://discord.com/invite/SKCxwPtevJ