X Project Template

A CookieCutter-based template designed to serve as a robust starting point for most startup projects hosted on GitHub.

This template aims to streamline the initial setup and provide a solid foundation for new projects, ensuring best practices are followed from the start.

Visit our website for more details.

Features

• Clean and Modular Structure: Predefined directory structure to keep your code organized.
• CI/CD Integration: Pre-configured GitHub Actions workflows for automated testing and deployment.
• Pre-configured Linters: Integrated with some tools to maintain code quality.
• Docker Support: Ready-to-use Dockerfile and Docker Compose setup for easy containerization.
• Customizable Templates: Modify to fit your project’s specific needs with minimal effort.

Getting Started

Prerequisites

• Python 3.8+
• CookieCutter

Usage

To generate a new project using this template:

cookiecutter gh:x-pt/template

Example Project

Check out an example project generated with this template:

• Example for C++ with CMake
• Example for C++ with XMake
• Example for CUDA with CMake
• Example for CUDA with XMake
• Example for Golang
• Example for Python
• Example for TypeScript

Contributing

We welcome contributions! Please see our CONTRIBUTING.md for guidelines on how to contribute to this project.

License

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

Acknowledgements

We gratefully acknowledge support from JetBrains.