Download the PHP package happytodev/typhoon without Composer

Content Management with flat database, using TALL Stack

Typhoon is a way to manage your content as you want. Why Typhoon ? Because he doesn't use database. It uses Orbit.

Support us

You can support the development of this open-source package here

Installation

Start with a fresh install of Laravel :

or

Enter in your project directory :

You can install the package via composer:

As Typhoon, use filament-navigation plugin from Ryan Chandler and as I adapted it (fork is here https://github.com/happytodev/filament-navigation) to be compliant with Orbit (also from Ryan) and as the PR is waiting approval from Ryan, you have to set an another settings before install Typhoon.

Follow these steps :

Save the composer.json file and run composer update

Alternatively, if you don't add above require block in your composer.json file, you can install the package via composer:

To use Orbit with filament-navigation, you have to add a key to your .env file :

Give a name to your website by adding the following key to your .env file

Always in your .env file replace following :

by

You can now run the install script of Typhoon via Artisan :

When the script ask you User model file already exists. Do you want to overwrite it? (yes/no) [no]: you can answer yes. It will modify the default User model to adapt it to use Orbit instead classic database like for example MySQL.

Last thing, go to the content\usersfolders and edit with your favorite editor the first user, usually it is the file 1.md:

modify this line is_admin: 0 to this one is_admin: true :

Crontabs

Typhoon has the possibity to published or unpublished posts by setting date and hour of action. It needs you configure your crontab as explained in laravel documentation.

The following must be adapted to your system, but on a classical Linux :

Then adding this and take care to adapt path of your Typhoon installation

Compile assets

Only if you need to adapt assets and compile them

Install TailwindCSS :

Install Npm dependencies and compile assets :

compile tailwind asset

Updating

After you update TyhoonCms with composer update you can launch php artisan typhoon:update.

The script will ask you wich version you come from and adapt the update in consequence.

How to connect

Now you can connect to the backoffice, via the url of your project and adding to it /admin

How to use

Out of the box, you have this entities :

• users
• posts
• categories
• tags
• pages
• navigation
• social networks

To create a post, a category is necessary. So, your first step is to create a category, before create a post.

After installation, you have demo content with :

• an home page
• your user and one more default user [email protected] and password : johndoesecret
• a category
• a tag
• a demo post : yourTyphoonSite.test/posts/the-first-post-with-typhoon
• a menu
• a social network group
• a page listing all posts : yourTyphoonSite.test/posts/

When you create a page, you can visit it with this url :

yourTyphoonSite.test/page/{slug_of_your_page}

The home page is different and is plug directly to yourTyphoonSite.test/

Knowned limitations

Don't forget : this is a beta version, please do not use it in production unless you know what you do !

Currently there is some limitations :

• In navigations, only one menu is usable with template provided and it name MUST be main
• In Social Networks, the name of the group MUST also be main

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Frédéric Blanc
• All Contributors

License

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

Versionning

TyphoonCms developement follows the SemVer method.