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">git clone git@github.com:confetti-sites/__your_repo__.git ~/__your_repo__</p> <p class="js-replace-username">cd __your_repo__</p>
Running your Project
<p class="pt-3 font-body text-pretty">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.</p>
Start Watching Changes
<p class="js-replace-username">cd ~/__your_repo__</p> <p class="js-replace-username">conf watch</p>
<p class="pt-3 font-body text-pretty">When you're done working, you can stop the watcher by pressing Control + C.</p>
Windows
<p class="pt-3 font-body text-pretty">First, make sure you have <a class="text-blue-500 hover:underline" target="_blank" href="https://scoop.sh/">Scoop</a> installed. Then you can add the Confetti bucket and install the CLI.</p>
Install Confetti
<p class="js-replace-username">scoop bucket add confetti https://github.com/confetti-cms/scoop-conf scoop install conf</p>
Clone the Project Repository
<p class="js-replace-username">git clone git@github.com:confetti-sites/__your_repo__.git $HOME\__your_repo__ cd $HOME\__your_repo__</p>
Running your Project
<p class="pt-3 font-body text-pretty">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.</p>
Start Watching Changes
<p class="js-replace-username">cd $HOME\__your_repo__ conf watch</p>
Linux
Install Confetti
<p class="js-replace-username">curl -L https://github.com/confetti-cms/client/releases/latest/download/conf-linux-amd64 -o conf chmod +x conf sudo mv conf /usr/local/bin/conf</p> <p class="pt-3 font-body text-pretty"><i>You might need sudo depending on your system configuration.</i></p>
Clone the Project Repository
<p class="js-replace-username">git clone git@github.com:confetti-sites/__your_username__.git ~/__your_username__ cd ~/__your_username__</p>
Running your Project
<p class="pt-3 font-body text-pretty">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.</p>
Start Watching Changes
<p class="js-replace-username">cd ~/__your_username__ conf watch</p>
Recommended Editor
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.