Skip to content

gavdilabs/cap-ts-generator

Repository files navigation

generator-gavdi-cap-ts

License

Yeoman-based (sub-)generator for basic CAP CDS typescript service application. This generator provides a quick scaffolding of a CAP cds project utilizing CDS-TS-DISPATCHER as its framework to reduce boiler plate code. This generator was build with the best practises and project structure we utilized at Gavdi.

📦 Installation

First, install Yeoman and generator-gavdi-cap-ts using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-gavdi-cap-ts

Then generate your new project:

yo gavdi-cap-ts

🎯 Features

  • Generates scaffolding of CAP cds typescript project ready-to-run and start developing.
  • Option to incorporate setup for production database: PostgreSQL and SAP Hana Cloud.
  • Option to incorporate basic setup for Bruno collection in the project.

🤝 Contributing

Contributions are welcome! While this project first and foremost was intended as a quick start for new projects wihtin Gavdi, this is also an open-source project, so please feel free to contribute in any way you can!

  • Issues: Report bugs and request features
  • Pull Requests: Submit improvements and fixes
  • Documentation: Help improve examples and guides
  • Testing: Share your use cases and edge cases

📄 License

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published