A couple months ago, I wrote a blog Introducing Cakecutter, which was, essentially, a modular version for create-python-project. Both of these projects were very easy, because they were just simple projects for me to practice the Rust programming language. I made them and forgot about it. But little did I know, small projects go a long way.
“Cakecutter is cool, let’s make it better”
And that’s exactly what we did.
We discussed new things we can implement, and decided to rewrite the entire thing in Golang
In a nutshell,
Cakes are templates, which contain everything you need to set up a project. This includes:
- The file structure of a project (for eg. some boilerplate files,
- File content (for eg. Pre-generated licenses, or boilerplate code) [DOCS]
- Commands to set up a project (for eg. Downloading dependencies, creating virtual environment) [DOCS]
Additionally, questions can be asked when setting up a project. Questions can be a selection between multiple things, or an input. Then, the answers to the questions can be used to fill in a template. [DOCS]
An example use case for this would be, asking the name of a user to auto-generate license, or you can even generate an entire README file with it!!
You can create files based on answer to a question, for example, creating a file only if the project is a typescript project.
And, you can even run commands based on answers. Example use case would be asking host OS to run setup commands!
This is a hell lot of power and functionality in just ONE CakeFile! (Just like real cakes 😆)
Head over to https://docs.cakes.run/1-install/, or use with NPX:
create-react-app , most people don’t like to make cakes. They like to eat them. We knew this, and a way to share cakes had to be made.
So, we created a
publish command, so you can publish your cakes for others to use!
Try out this command to instantly generate a very simple python project template. Now you don’t need to create cakes!
npx cc cut python
Also, we created the website Cakes.run where you can find the documentation, installation guidelines, and also browse the cakes created by others.
The entire stack - from the API, website, CLI, Docs - Everything is open source. You can find them on the Cake-cutter github organisation.
⭐ Star all repositories to spread the word. Especially this one, the main CLI 👇🏻
Open source, cross-platform developer tool that helps you quick-start your project. Creates files, runs commands, templating based on question. Also works as a setup tool
👀 What is Cakecutter?
Sometimes, the most difficult thing is to just get started with a project. Cakecutter is a tool that helps you to cut the cake and start your amazing project instantly.
What Cakecutter does:
- Users can publish, create or use a cake from Cakes.run. Cakes are basically TOML files which contain all the information needed to create a project.
- According to the information in the
Cakefile, Cakecutter will create all the files and (you can also fill them with content) in the correct location.
- Setup commands (installing dependencies, etc) can be defined in the
Cakefile. These commands are run after the files are generated.
- Cakecutter can ask questions to the user and take input. The input can then be used as variables for the project template. Read the docs here
Follow Yash, the major contributor of this project, on DEV community and Github - https://github.com/kekda-py
Follow me, Dhravya Shah on Github - https://github.com/dhravya