INSTALLATION.md

Installation

Table of Contents

• Requirements
• Installation
  • 1. Get the source
  • 2. Install Composer dependencies
  • 3. Set up environment variables
  • 4. Set up database
• Notes

Requirements

You are, of course, free to install this project your way. However if you plan on following this install guide, there are a few requirements:

• PHP
• Composer
• Laravel Valet

For detailed steps on how to install these requirements, please refer to their respective install guides. For information on what version to install, refer to our composer.json file.

1. Get the source

Clone the repository using git. Make sure to do this in a folder that is parked by Valet.

$ git clone https://github.com/Kurozora/kurozora-web.git && cd kurozora-web

2. Install Composer dependencies

Use Composer to install all of the project's dependencies.

$ composer install

3. Set up environment variables

Create a copy of the .env.example file ..

$ cp .env.example .env

.. and modify the values accordingly.

4. Set up database

Create a database and configure the details in your .env file. After that, you can migrate the database to get the correct schema.

$ php artisan migrate

Optionally, you can choose to also seed the database with test data.

$ php artisan migrate:fresh --seed

Notes

If you are using PHPStorm, you may suppress the "multiple definitions exist" notice by disabling the following option in the preferences.

Settings | Editor | Inspections | PHP | Undefined symbols | Multiple class declarations