{"id":15283903,"url":"https://github.com/happytodev/typhoon","last_synced_at":"2025-04-12T23:20:34.435Z","repository":{"id":45909780,"uuid":"491669267","full_name":"happytodev/typhoon","owner":"happytodev","description":"A new open source CMS without database using TALL stack","archived":false,"fork":false,"pushed_at":"2023-10-09T08:50:04.000Z","size":1063,"stargazers_count":5,"open_issues_count":7,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-26T17:21:17.334Z","etag":null,"topics":["alpinejs","filamentphp","laravel","livewire","orbit","php","tailwindcss","tall"],"latest_commit_sha":null,"homepage":"https://typhooncms.itanea.fr","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/happytodev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["happytodev"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2022-05-12T21:11:51.000Z","updated_at":"2024-05-31T08:46:31.000Z","dependencies_parsed_at":"2023-02-01T06:01:04.670Z","dependency_job_id":null,"html_url":"https://github.com/happytodev/typhoon","commit_stats":null,"previous_names":[],"tags_count":48,"template":false,"template_full_name":"spatie/package-skeleton-laravel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/happytodev%2Ftyphoon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/happytodev%2Ftyphoon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/happytodev%2Ftyphoon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/happytodev%2Ftyphoon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/happytodev","download_url":"https://codeload.github.com/happytodev/typhoon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248643967,"owners_count":21138534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alpinejs","filamentphp","laravel","livewire","orbit","php","tailwindcss","tall"],"created_at":"2024-09-30T14:48:09.829Z","updated_at":"2025-04-12T23:20:34.415Z","avatar_url":"https://github.com/happytodev.png","language":"CSS","funding_links":["https://github.com/sponsors/happytodev"],"categories":[],"sub_categories":[],"readme":"\n\n# Content Management with flat database, using TALL Stack\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/happytodev/typhoon.svg?style=typhoon-square)](https://packagist.org/packages/happytodev/typhoon)\n[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/happytodev/typhoon/run-tests?label=tests)](https://github.com/happytodev/typhoon/actions?query=workflow%3Arun-tests+branch%3Amain)\n[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/happytodev/typhoon/Check%20\u0026%20fix%20styling?label=code%20style)](https://github.com/happytodev/typhoon/actions?query=workflow%3A\"Check+%26+fix+styling\"+branch%3Amain)\n[![Total Downloads](https://img.shields.io/packagist/dt/happytodev/typhoon.svg?style=typhoon-square)](https://packagist.org/packages/happytodev/typhoon)\n\nTyphoon is a way to manage your content as you want.\nWhy Typhoon ? Because he doesn't use database. It uses Orbit.\n\n## Support us\n\n[You can support the development of this open-source package here](https://github.com/sponsors/happytodev)\n\n## Installation\n\nStart with a fresh install of Laravel :\n\n```bash\nlaravel new your-awesome-project-name\n```\n\nor \n\n```bash\ncomposer create-project laravel/laravel your-awesome-project-name\n```\n\nEnter in your project directory : \n\n```bash\ncd your-awesome-project-name\n```\n\nYou can install the package via composer:\n\n```bash\ncomposer require happytodev/typhoon\n```\n\nAs 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.\n\nFollow these steps :\n\n```json\n    \"repositories\": [\n        {\n          \"type\": \"vcs\",\n          \"url\": \"https://github.com/happytodev/filament-navigation\"\n        }\n    ],\n    \"require\": {\n      \"ryangjchandler/filament-navigation\": \"dev-main\"\n    }\n```\n\nSave the `composer.json` file and run `composer update`\n\nAlternatively, if you don't add above require block in your `composer.json` file, you can install the package via composer:\n\n```bash\ncomposer require ryangjchandler/filament-navigation=dev-main\n```\n\nTo use Orbit with filament-navigation, you have to add a key to your .env file :\n\n```env\n  FILAMENT_NAVIGATION_DB_ENGINE=orbit\n```\n\nGive a name to your website by adding the following key to your .env file\n\n```env\nTYPHOONCMS_NAME=\"MyWebsite\"\n```\n\nAlways in your `.env` file replace following :\n\n```env\nDB_CONNECTION=mysql\nDB_HOST=127.0.0.1\nDB_PORT=3306\nDB_DATABASE=\nDB_USERNAME=\nDB_PASSWORD=\n```\n\nby\n\n```env\nDB_CONNECTION=orbit\n```\n\nYou can now run the install script of Typhoon via Artisan :\n\n```bash\nphp artisan typhoon:install\n```\n\nWhen 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.\n\n\n\nLast thing, go to the `content\\users`folders and edit with your favorite editor the first user, usually it is the file `1.md`:\n\n```md\n---\nid: 1\nname: 'John Doe'\nemail: john@doe.com\npassword: $2y$10$0wdxKSl7ksxk8yrTgU8!K90oLmMq2eJ20pwUBSu0ICMWpc959DpTqm\nis_admin: 0\ncreated_at: 2022-05-27T18:39:22+00:00\nupdated_at: 2022-05-28T09:04:57+00:00\n---\n```\n\nmodify this line `is_admin: 0` to this one `is_admin: true` :\n\n```md\n---\nid: 1\nname: 'John Doe'\nemail: john@doe.com\npassword: $2y$10$0wdxKSl7ksxk8yrTgU8!K90oLmMq2eJ20pwUBSu0ICMWpc959DpTqm\nis_admin: true\ncreated_at: 2022-05-27T18:39:22+00:00\nupdated_at: 2022-05-28T09:04:57+00:00\n---\n```\n\n# Crontabs\n\nTyphoon has the possibity to published or unpublished posts by setting date and hour of action.\nIt needs you configure your crontab as explained in [laravel documentation](https://laravel.com/docs/9.x/scheduling#running-the-scheduler).\n\nThe following must be adapted to your system, but on a classical Linux : \n\n```bash\ncrontab -e\n```\n\nThen adding this and take care to adapt path of your Typhoon installation\n\n```bash\n* * * * * cd /path-to-your-project \u0026\u0026 php artisan schedule:run \u003e\u003e /dev/null 2\u003e\u00261\n```\n\n\n# Compile assets\n\nOnly if you need to adapt assets and compile them\n\nInstall TailwindCSS :\n\n```bash\nnpm install -D tailwindcss\n```\n\n```bash\nnpm install @tailwindcss/typography\n```\n\nInstall Npm dependencies and compile assets :\n```bash\nnpm install \u0026\u0026 npm run dev\n```\n\ncompile tailwind asset\n```bash\nnpx tailwindcss -i ./resources/css/app.css -o ./public/css/app.css\n```\n\n## Updating\n\nAfter you update TyhoonCms with `composer update` you can launch `php artisan typhoon:update`.\n\nThe script will ask you wich version you come from and adapt the update in consequence.\n\n\n\n# How to connect\n  \nNow you can connect to the backoffice, via the url of your project and adding to it `/admin`\n\n# How to use \n\nOut of the box, you have this entities :\n\n- users\n- posts\n- categories\n- tags\n- pages\n- navigation\n- social networks\n\nTo create a post, a category is necessary. So, your first step is to create a category, before create a post.\n\nAfter installation, you have demo content with :\n- an home page\n- your user and one more default user **john@doe.com** and password : **johndoesecret**\n- a category\n- a tag\n- a demo post : `yourTyphoonSite.test/posts/the-first-post-with-typhoon`\n- a menu\n- a social network group\n- a page listing all posts : `yourTyphoonSite.test/posts/`\n\nWhen you create a page, you can visit it with this url : \n\nyourTyphoonSite.test/**page**/{slug_of_your_page}\n\nThe home page is different and is plug directly to `yourTyphoonSite.test/`\n\n# Knowned limitations\n\n**Don't forget : this is a beta version, please do not use it in production unless you know what you do !**\n\nCurrently there is some limitations :\n\n- In navigations, only one menu is usable with template provided and it name MUST be `main`\n- In Social Networks, the name of the group MUST also be `main`\n\n## Testing\n\n```bash\ncomposer test\n```\n\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](https://github.com/happytodev/.github/blob/main/CONTRIBUTING.md) for details.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](../../security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n- [Frédéric Blanc](https://github.com/happytodev)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n\n## Versionning\n\nTyphoonCms developement follows the [SemVer](https://semver.org/) method.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhappytodev%2Ftyphoon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhappytodev%2Ftyphoon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhappytodev%2Ftyphoon/lists"}