Installation
Follow the steps below to get started. Keep in mind that you don't need to install PHP or an HTTP server to use Confetti.
Installation
Follow the steps below to get started. Keep in mind that you don't need to install PHP or an HTTP server to use Confetti.
Mac
Install Confetti
<p class="js-replace-username">brew tap confetti-cms/homebrew-client && brew install conf</p>
Clone the project repository
<p class="js-replace-username">cd ~</p> <p class="js-replace-username">git clone git@github.com:confetti-sites/__repo__.git</p> <p class="js-replace-username">cd __repo__</p>
Confetti is a powerful tool for building and managing websites with ease. Follow the steps below to get started on macOS. Keep in mind that you don't need to install PHP or an HTTP server to use Confetti.
| Step | macOS (Homebrew) | Windows (Scoop, PowerShell) |
|---|---|---|
| 1 | Install Confetti: | Install Confetti: |
brew tap confetti-cms/homebrew-client && brew install conf |
scoop bucket add org https://github.com/confetti-cms/scoop-conf.gitscoop install confetti-cms/scoop-conf
|
|
| 2 | Navigate to the desired directory: | Navigate to the desired directory: |
cd ~ |
cd ~ |
|
| 3 | Clone the project repository: | Clone the project repository: |
git clone git@github.com:confetti-sites/__repo__.git |
git clone git@github.com:confetti-sites/__repo__.git |
|
| 4 | Move into the project directory: | Move into the project directory: |
cd ~/__repo__ |
cd ~\__repo__ |
Whenever you want to work on your website, run the following command to start watching for changes. This runs the site remotely and updates it automatically as you edit.
conf watchThis command keeps the project running and applies updates as you work.
When you're done working, you can stop the watcher by pressing Control + C.
We recommend using PhpStorm for development, as it provides full autocomplete support for all Confetti functionalities by default, including PHP in Blade files. Visual Studio Code (VS Code) lacks this feature, making PhpStorm a more efficient choice for working with Confetti projects.
That's it! You're now ready to start building and managing your website with Confetti.