Installation

Get a Wake site running on your computer.

This page gets Wake running on your own computer, for development or to try it out. To put a site online, see Install on a web host.

What you need

Check with:

php -v
composer -V

Steps

  1. Get the code.

    git clone https://github.com/IonFlux84/wake.git my-site
    cd my-site
    
  2. Install the dependencies. They go into wake/vendor/.

    composer --working-dir=wake install
    
  3. The settings file .env is created with a fresh application key on the first request. To create it yourself instead:

    cp .env.example .env
    php wake/artisan key:generate
    
  4. Start the development server.

    php wake/artisan serve
    
  5. Open http://localhost:8000. You see the demo site from content/.

  6. Create your account. Open http://localhost:8000/wake. On the first visit Wake asks for your name, email address and a password, and makes you the owner of the site. Accounts are stored as files in data/accounts/.

What is where

Folder Contents
wake/ the application. Don't change anything here, an update replaces it
content/ your pages, posts, categories, tags and media, one folder per entry
themes/ the looks of the website, e.g. Tide
plugins/ extensions
settings/ config.php, the settings from the panel (general.yml), menus, redirects, roles, consent
data/ accounts, statistics, versions, trash and backups. Back it up; never public
temp/ caches, locks and logs. Wake makes them again, you may delete them
public/ the folder your web server serves

Continue with Your first site. Read Architecture to see how these fit together, and Configuration for everything you can set in settings/config.php.

source: docs/getting-started/installation.md