PickleCMS

PickleCMS is a powerful content management system utilizing Laravel v12, React v19, Shadcn/ui, and Inertia 2.0 to deliver a seamless developer experience.

Resources

Important Notes:

You will need to install a php and laravel.

• Laravel 12 Documentation
• Inertia 2.0 Documentation
• React 19 Documentation
• TailwindCSS Documentation
• Vite Documentation
• Bun JS Runtime Documentation

Getting Started

To start, add this alias to your .bashrc or .zshrc:

alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'

Setup Script

Follow these steps to get your project up and running:

This script will clone the repository, set up the .env file, and generate an APP_KEY for encrypting cookies.

git clone [email protected]:saintpickle/picklecms.git
cd picklecms
cp .env.example .env
composer install
sail up -d
sail bun install
sail artisan key:generate
sail artisan migrate

Running the environmenmt

This script will run the previously built docker containers and start the js runtime. CTRL-C stops the JS runtime and proceeds with the command to stop the docker containers.

sail up -d; bun run dev; sail down

Commands to Use Inside the Sail Container

Refer to the Laravel v12 Documentation for detailed information on Laravel commands. The Sail environment includes various toolchains such as Node, Bun, pnpm, and npm. Bun is what will be used for this project, but you can change these in your own version as you well please. You can run these commands using the Sail prefix. Note: These are examples to run, not a script.

• Note: These are examples of commands you can run inside the sail environment

# Create a new controller
sail artisan make:controller MyController

# Install dependencies with pnpm
sail bun install

# Install dependencies with composer
sail composer install