shipaurora / aurora
A new website on Aurora CMS: a Laravel app with the CMS installed, ready to make your own.
Requires
- php: ^8.4
- laravel/framework: ^13.17
- laravel/tinker: ^3.0
- shipaurora/cms: ^1.0
Requires (Dev)
- fakerphp/faker: ^1.23
- laravel/boost: ^2.2
- laravel/pail: ^1.2.5
- laravel/pao: ^1.0.6
- laravel/pint: ^1.27
- mockery/mockery: ^1.6
- nunomaduro/collision: ^8.6
- pestphp/pest: ^5.3
- pestphp/pest-plugin-laravel: ^5.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Aurora
The starter app for a new website on Aurora, a content management system for Laravel, built on Filament. It's a Laravel application with the CMS already installed, ready to make your own: editors build pages in a visual editor on the real design, and the website stays plain Laravel code.
Requirements
- PHP 8.4 or newer, with the GD or Imagick extension
- Composer 2 and Node.js 20 or newer
- A database: SQLite, MySQL/MariaDB or PostgreSQL
Create a site
composer create-project shipaurora/aurora my-site # asks a few questions and sets it all up cd my-site
create-project ends by running php artisan aurora:install, which sets up the database and what
the CMS needs, creates your admin account, and builds the website's front end (npm install and
npm run build; Node.js is needed for that). Say yes when it offers to run the website's own
seeders: that publishes the first homepage. (Without a terminal to answer in, for example with
--no-interaction, it tells you to run php artisan aurora:install yourself.) Then open the site
(with Laravel Herd, http://my-site.test; otherwise php artisan serve)
and sign in at /admin.
What's in it
| Where | What |
|---|---|
app/Blocks/WelcomeBlock.php |
The homepage's block: an example of a block of the website's own, its fields and its picture in the editor |
resources/views/components/blocks/welcome.blade.php |
The block's view, the same on the website and in the editor |
resources/views/vendor/aurora/layouts |
The page layouts (standard, landing page, minimal and blank), published to make your own |
resources/css/app.css |
The website's stylesheet, which the visual editor shows on its canvas too |
database/seeders/HomepageSeeder.php |
The first homepage, in English and Norwegian |
resources/lang/nb.json |
Norwegian labels for the website's own block |
config/aurora.php |
Aurora's settings |
Next steps
- Edit the homepage in the visual editor, or replace it with blocks of your own.
- Add a block with
php artisan aurora:make-block "Pricing table". - Make the layouts in
resources/views/vendor/aurora/layoutslook like your website. - Add a layout of your own with
php artisan make:aurora-layout "Campaign". - Add people with
php artisan make:aurora-user, choosing each one's role.
Documentation
Everything else (the visual editor, blocks, layouts, users and roles, languages, AI assistants, the APIs and configuration) is in the documentation at shipaurora.com/docs.
License
Aurora is open-source software licensed under the MIT license.