Skip to content

orchidcommunity/press

Repository files navigation

Official Documentation

Documentation can be found at Orchid website.

You can watch live

Login: [email protected] Password: password

System requirements

Make sure your server meets the following requirements.

  • MySQL Server 5.7.8+ or PostgreSQL
  • PHP Version 7.0+

Install

Via Composer

Going your project directory on shell and run this command:

$ composer require orchid/cms

Provider and Facades

Add to config/app.php:

Service provider to the 'providers' array:

'providers' => [
  // Laravel Framework Service Providers...
  //...

  // Package Service Providers
  Orchid\Platform\Providers\FoundationServiceProvider::class,
  Orchid\CMS\Providers\FoundationServiceProvider::class,

  // ...

  // Application Service Providers
  // ...
];

Facades aliases to the 'aliases' array:

'aliases' => [
  // ...
  'Dashboard' =>  Orchid\Platform\Facades\Dashboard::class,
  'Alert' =>  Orchid\Alert\Facades\Alert::class,
  'Active' => Watson\Active\Facades\Active::class,
  'Setting' =>  Orchid\Setting\Facades\Setting::class,
  'Image' => Intervention\Image\Facades\Image::class,
];

User

Inherit your model App\User

namespace App;

use Orchid\Platform\Core\Models\User as UserOrchid;

class User extends UserOrchid
{

}

Finish

Go to url: localhost:8000/dashboard

The graphical installation does not work if the server is started using the artisan serve command, if you want to use a local server, please go to the public directory and run

php -S localhost:8000

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Credits

License

The MIT License (MIT). Please see License File for more information.