Quick start guide

Hey there! 👋 Welcome to Fastree—let’s get you started with templates and examples to build your project effortlessly!

🎨 Exploring Templates

Fastree provides pre-built templates to help you set up your project quickly. To check out the available templates, head over to Fastree Templates

Once you find a template that suits your needs, simply copy its configuration and paste it into your .fastree.config.json file.

📌 Adding a Template to Your Project

1. Visit Fastree Templates.
2. Select a template you like.
3. Copy the template configuration.
4. Open .fastree.config.json in your project.
5. Paste the copied template inside the configuration file.

Your file should now look something like this:

{
  "structure": [
    {
      "path": "src/components",
      "folders": [
        {
          "name": "<feature-name>",
          "files": [],
          "folders": []
        }
      ],
      "files": [
        {
          "name": "<feature-name>-component.tsx",
          "template": "ReactComponent"
        }
      ]
    }
  ]
}

After adding the template, save the file and run:

npx fastree generate <feature-name>

This will generate the required files and set up the project structure based on the template you chose. 🎉

🛠 Understanding the Configuration

If you're wondering how the .fastree.config.json file works, we've got you covered! Check out the detailed guide here: Understanding Fastree Config

This guide will explain each configuration option so you can customize your project just the way you want.

If you have any questions, feel free to check out the docs or send me a email. Happy coding! 😃