Projen Project Types

A collection of opinionated custom project templates for projen.io.

Overview

This repository provides curated project types that extend projen's capabilities with opinionated configurations and best practices. These project types are designed to accelerate development workflows while maintaining consistency and quality across projects.

Requirements

Documentation

This project uses MkDocs for documentation. To work with the documentation locally, you need to install the following dependencies:

# Install MkDocs and Material theme
pip3 install mkdocs mkdocs-material

# Install Mike for documentation versioning
pip3 install mike

Development Commands

Once the requirements are installed, you can use the following commands:

# Build the documentation
yarn docs:build

# Serve the documentation locally (with live reload)
yarn docs:serve

The documentation will be available at http://localhost:8000 when using the serve command.

Features

• 🚀 Ready-to-use project templates for various use cases
• 📦 Integrated tooling with sensible defaults
• 🔧 Customizable configurations to fit your needs
• 📚 Comprehensive documentation with MkDocs Material theme
• 🔄 Continuous integration templates included

Getting Started

More detailed documentation and project types will be added as features are developed. Visit the documentation site for the latest information.

Contributing

Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests to help improve these project types.

License

This project is licensed under the terms specified in the LICENSE file.