Installation
Suggest EditThis beginner guide will help you to start using ORCHID. We’ve listed up the main steps you should perform to
launch the project. The platform is based on the Laravel Framework,
therefore first thing you shall do is install Laravel and check if your computer meets the
system requirements.
Create project
The platform and the framework use the Composer to provide and control your dependencies.
Install the framework with the composer create-project command in your terminal:
composer create-project laravel/laravel orchid "5.6.*" --prefer-dist
This will create a new folder orchid, download some dependencies into it and even generate main folders and files
required to start your work. In other words it will install your new framework project.
Don’t have the Composer? It’s easy to install it following the tutorial at download page.
Don't forget to
- Set the «chmod -R o+w» rights for folders
storageandbootstrap/cache - Edit the
.envfile
Add package
Go to the created project folder and execute the following command:
composer require orchid/platform
Notice. If you have installed the Laravel the other way you will have to generate the key using the command
php artisan key:generate
Publish preferences
To publish your preferences and extra files do the following:
php artisan vendor:publish --provider="Orchid\Platform\Providers\FoundationServiceProvider"
php artisan vendor:publish --all
Notice. You also need to create a new database, add the credentials to the
.envfile and add your app URL to theAPP_URLvariable.
Apply all our migrations to create a database:
php artisan migrate
Make the user styles, javascript scenarios and other linkable files available:
php artisan storage:link
php artisan orchid:link
Notice. Some platforms (vagrant) can not create symbolic links with this commands. And it may become necessary to manually perform the following commands
cp -rf vendor/orchid/platform/public public/orchidandmkdir -p public/storage/public
User model
The platform is shipped with the prepared bundle of user functions, for example, access rights security, that’s why
it’s necessary to extend the base user model in App\Users:
namespace App;
use Orchid\Platform\Core\Models\User as BaseUser;
class User extends BaseUser
{
}
Run the following command to create a user with supreme (at the moment of creation) rights passing the username, e-mail and password:
php artisan make:admin admin admin@admin.com password
Run project
To run the project you may use the built-in server:
php artisan serve
Open the browser and go to http://localhost:8000/dashboard. If everything works properly you will see the
dashboard login page. Later, when you will end your work, stop the server with Ctrl+C shortcut in your terminal.
Notice. If the used runtime environment is set to work on other domain, (eg: orchid.loc), the dashboard will not be accessible and you will have to set it in config file
config/platform.phpor in.env. This allows to make a dashboard accessible from other domains or subdomains, for example,dashboard.example.com.
Had an issue during installation? Perhaps someone has already met the same problem https://github.com/orchidsoftware/platform/issues . If not, you may send a message or request assistance.