Skip to content

kontent-ai/kickstart-angular-app

Kontent.ai Kickstart Sample Angular App

Contributors Forks Stargazers Issues MIT License Discord

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

Getting Started

1. Install dependencies

npm install

2. Set up your environment

Copy .env.template to .env and fill in your Kontent.ai credentials:

cp .env.template .env
# Used by Angular runtime (ng serve / ng build)
NG_APP_ENVIRONMENT_ID=your-environment-id
NG_APP_DELIVERY_API_KEY=your-delivery-api-key

# Used by scripts (model:generate, model:import, env:sync)
VITE_ENVIRONMENT_ID=your-environment-id
VITE_DELIVERY_API_KEY=your-delivery-api-key
VITE_MANAGEMENT_API_KEY=your-management-api-key

3. Run setup

Syncs your .env into src/environments/environment.ts and imports the completed Kontent.ai backup in one command:

npm run setup

4. Start the app

npm start

Open your browser at http://localhost:4200.


Other Scripts

Script Description
npm run env:sync Re-sync .env into src/environments/environment.ts after credential changes
npm run model:generate Regenerate TypeScript models after updating the content model in Kontent.ai
npm run model:import --filename="<path>" Import a specific backup from ./scripts/backups
npm run build Build for production into dist/
npm run lint Run ESLint
npm run biome:check Run Biome linter and formatter checks
npm run biome:fix Run Biome and auto-fix issues

Warning

model:import will clean your environment first — all existing content will be removed before importing.

Note

Two backups are available in ./scripts/backups: kickstart-base.zip (minimal content) and kickstart-completed.zip (fully populated).

Contributing

  • Report Issues: Use 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.

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

License

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

Support & Resources


About

The Kontent.ai Kickstart Angular App is a sample application designed to facilitate learning of Kontent.ai.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors