Commit ccfa9090 authored by benjamin melançon's avatar benjamin melançon 🛠️
Browse files

Update Quickstart documentation

parent 0e2ba1ce
Loading
Loading
Loading
Loading
+18 −13
Original line number Diff line number Diff line
# Quickstart

There are two ways to get Drutopia up and running:
There are two quick ways to get Drutopia up and running: PHP on your local computer or a full, production-like environment provided by a virtual machine.

## 1. Composer
In both cases we'll end with the Drutopia distribution codebase, built by Composer, in a directory called `my-drutopia-site` (please change this to whatever you would like in the instructions below!).

## PHP-only

### Prerequisites
1. [A local server for Drupal](https://www.drupal.org/docs/develop/local-server-setup)

1. PHP (test in a terminal with `php --version`; here's the [daunting documentation if it's not already there](http://php.net/manual/en/install.php).
2. [Composer](https://getcomposer.org/download/)

> **Note**: If you have composer installed [globally](https://getcomposer.org/doc/00-intro.md#globally) you can use `composer` instead of `./composer.phar` in the first command.

### Instructions

1. Run this command replacing DIRECTORY with your desired directory name - `composer create-project drutopia/drutopia_template:dev-master --no-interaction DIRECTORY`
2. Create a MySQL database for your site
3. Open your Drutopia site and follow the installation instructions
1. Run this command in a terminal: `./composer.phar create-project drutopia/drutopia_template:dev-master --no-interaction my-drutopia-site`
2. When it's complete, `cd my-drutopia-site/web` and `php -S localhost:8008`
3. Open [localhost:8008](http://localhost:8008/) and follow the installation instructions; leaving everything at defaults will be fine.


## 2. Vagrant
## Virtual machine

### Prerequisites

@@ -24,10 +29,10 @@ There are two ways to get Drutopia up and running:

### Instructions

1. `git clone git@gitlab.com:drutopia/drutopia_vm.git drutopia_vm`
1. `git clone git@gitlab.com:drutopia/drutopia_vm.git my-drutopia-site`
2. `cd drutopia_vm`
3. `vagrant up`
4. Access your site at the drutopiavm.local
5. Log in at drutopiavm.local/user with the credentials username: admin, password: admin
6. Enable Drutopia modules at /admin/modules
7. Access the virtual machine (for use of Drush etc) with `vagrant ssh`
3. `vagrant up` (this runs a site install via drush but [unfortunately no Drutopia features are enabled](https://gitlab.com/drutopia/drutopia/issues/151)).
4. Log in at [my-drutopia-site.test/user](http://my-drutopia-site.test/user) with the credentials username: admin, password: admin
5. Enable Drutopia modules at [my-drutopia-site.test/admin/modules](http://my-drutopia-site.test/admin/modules)

You can access the virtual machine (for use of Drush etc) with `vagrant ssh`.