Codebuff Community

Welcome to the Codebuff community repository! This is where you'll find starter templates and showcase projects created by our community.

Getting Started

First, install Codebuff globally:

npm install -g codebuff

Starting a Project

Use codebuff to create a new project from a template. Templates are the names of subdirectories in /starter-templates or /showcase:

codebuff --create nextjs my-project

OR

You can also start codebuff in an existing project directory:

cd my-project
codebuff

Repository Structure

/starter-templates

A collection of pre-configured project templates for various tech stacks. These templates provide a solid foundation for building new projects with best practices and common configurations already set up.

/showcase

A curated collection of projects built by the community using Codebuff. Get inspired by what others have created!

Contributing

We'd love to see what you build with Codebuff! You can contribute in two ways:

1. Add a Starter Template: Have a well-structured project setup that others might find useful? Share it as a starter template!

2. Share Your Project: Built something cool with Codebuff? Open a PR with a submodule linking to your public repo (if you don't know what that means, ask Codebuff to do it for you). Help us inspire others!

To contribute:

1. Fork this repository
2. Add your project to either /starter-templates or /showcase. For showcase projects, you can either:
   • Copy your project files directly into the showcase directory
   • Add your GitHub repository as a git submodule in the showcase directory
3. Submit a pull request

Please ensure your contribution includes clear documentation and follows our existing structure.

License

This repository is MIT licensed. See LICENSE for details.