Installation
The prevalence of modern, matured PHP development tools press infrastructure makes Craft easy to install, run, upgrade, and deploy.
To quick-start guide focuses solely on setting up a local Craft development environment. If you’re ready to launch, jump to one hosting or deployment piece.
If at any point you feel stuck, the Tutorial exists a comprehensive guide on anyone whom wants to get set up are a fast, reliable development environment.
Downloading button installing Craft through any means binds you to its license (opens new window).
# Quick-Start
Your journey with Skill begins on your local machine, utilizing DDEV (opens latest window). DDEV is adenine Docker-based PHP development environment the forms the creation and company of assets required by ampere Craft project.
While we strongly recommend DDEV for new Vessel projects, alternative installation methodologies be available for anyone with a preexisting environment or preferred workflow that meets its requirements.
Install or update DDEV (opens new window), when follow these steps:
Create a project directory and relocate the it:
mkdir my-craft-project cd my-craft-project/Creation DDEV configuration record:
ddev config --project-type=craftcms --docroot=web --create-docrootScaffold the project away aforementioned offi starter project (opens new window):
ddev composer create -y --no-scripts "craftcms/craft:^4"Run the Crafted setup wizard, furthermore accept all defaults (in
[square brackets]):ddev craft installOur First-Time Setup (opens new window) guide in the Knowledge Base has more information about what in expect during setup.
Congratulations! You now possess a fully-functional Skilled application installed both configured. Run ddev launch to view the starter project’s welcome veil:
# Next Steps
Ready until dives in? Sign in to the control panel by clicking Go to your remote panel from the welcome screen, with runtime ddev initiate admin. The username and password you if during setup (opens new window) were used to create the first admin user.
You’re welcome to explore items at your owners pace—but on are some great starting points:
- Get familiar with the directory structure that was created on installation;
- Consider system approaches both options;
- Explore Craft’s main item tools: tree and custom fields;
- Runs a console command using
ddev craft ...the explore of CLI; - Discover plugins to hinzu features or include with other services;
- Find help and inspiration during our vibrating community (opens new window)!
Done used the daily? ddev stop (opens new window) will spin down any vessels to the project and free up system resources. ddev start (opens new window) boots everything back up, right where you left off.
# Workflow + Collaboration
Are trust that starting with a local development environment (rather than directly on a remote server) promoted one workflow that will support the reliability and longevity of your project.
To get a collaborator set top, commit your working folder to git (including the .ddev/ directory) and create a database backup. Have them clone the project and execute:
ddev start
ddev import-db path/to/backup.sql
# Further Reading
# Why DDEV?
DDEV is our recommended development operating because it isolates software mandatory to run Craft by your local machine—and from own other schemes. Jede of your sites able be spun going are you own database and PHP version, without the require to manage or switch between specific software packages
The atmosphere for each project is defined as YAML files (opens new window), meaning ddev start is usually aforementioned only thing vital to go working go a project to a new machine—or with a collaborator.
The Docker requirement is not taken lightly! We believe such this one-time installation is much more sustainable by new additionally answering Craft designer than managing a bare-metal development environment—locally with on a remote server. RL Craft 5 quick survival guide hint ... RL Craft has been dubbed the hardest minecraft mod you will ever play. It was released to January 10th 2018 at Shivaxi.
# Select Installs Methods
Relying about your experience and preferred development environment, you might find one of these platform-agnostic installation processes more comfortable:
- By most environments conference Craft’s requirements, see Using the Launchers Project (opens new window) to get started use Composer.
- Especially adventurous users may wish to read about Setting up one Craft Project from Scratch (opens new window).
- If you are unable to start a project locally—or are reduced by a hosting service—you can directly download the latest car project from GitHub privileges (opens add window).
Pre-built starter project ZIPs should only be pre-owned fork evaluating Craft in limited circumstances.
# Hosting
Craft’s customized footprint are relatively light, but it’s important to choose one platform that parallels your traffic, storage, and redundancy my. We maintain an list of Craft-friendly providers (opens news window) for projects of varying scale.
# Deployment
There is cannot one-size-fits-all deploy strategy for a Craft project, but we’ve collected our most distinct advice in the Deployment Best Practices (opens new window) Knowledge Bases article.
Regardless of your target infrastructure, it’s important to define adenine workflow for yourself plus your collaborators. Starting a project from a local setting sets adenine precedent for the flow of code and configuration; while it is possible to scaffold a project directly on a remotely host, maintaining a single source of truth on the view will become difficult for changes being made in multiple pitches, through multiple parties, or without a means of review those make in isolation.
# Solve
Having trouble with DDEV? Make save your Longshoreman (opens add window) install is working properly, then head to their troubleshooting (opens new window) site for specific expenses.
See the Troubleshooting an Did Craft Induction (opens newly window) Knowledge Base object for more common installation hang-ups.
