https://github.com/sonyarianto/doitsu
Simple and generic web framework based on PHP, mostly only routing and templating.
https://github.com/sonyarianto/doitsu
alpinejs framework php tailwindcss twig web
Last synced: 11 months ago
JSON representation
Simple and generic web framework based on PHP, mostly only routing and templating.
- Host: GitHub
- URL: https://github.com/sonyarianto/doitsu
- Owner: sonyarianto
- License: mit
- Created: 2023-02-03T11:54:20.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-25T04:59:38.000Z (about 3 years ago)
- Last Synced: 2024-10-12T12:52:16.309Z (over 1 year ago)
- Topics: alpinejs, framework, php, tailwindcss, twig, web
- Language: CSS
- Homepage:
- Size: 104 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Doitsu
Simple and generic web framework based on PHP, mostly only routing and templating.
## Requirements
- Make sure PHP is available on your system. We recommend PHP 8 or above. [[PHP installation manual]](https://www.php.net/manual/en/install.php)
- Make sure Composer is available on your system. [[Composer installation manual]](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos)
> Still confuse about above things? Just ask on Discussions channel
## How to run
- Clone this repository
- Go to the project directory (usually using `cd` command)
- Run `composer -vvv install` (this command is to install the dependencies, will create `vendor` directory)
- Run `php -S 0.0.0.0:4000 -t public` (this command is to run the built-in PHP web server for development purpose)
- Open the web on your browser at `http://localhost:4000` (until this point it means we already have `/` route that handle the home page)
## Sample output
## What next?
It depends on your imagination. For example in our use case, we use this framework with Alpine.js to handle the reactivity, add date-fns to manipulate date, add Tailwind CSS for nice styling flow and sometimes add Flowbite to take the component advantage of nice visual UI. The limit is your creativity.
## Quick FAQs
- **Want to add new route such as /about or anything?** Just go to `src/_routes.php` and add there. Observe the current code. After you create new route usually you will create a method on `Application` class (located at `src/Application.php`) to execute some code (a.k.a controller) before you render some visual page (a.k.a view).
- **Can I deploy to shared hosting?** Yes, but you should point the website to the `public` folder, since that folder is the entry point or commonly said as web root directory. There is `index.php` file there and everything starts from that script.
- **Can I deploy using Docker?** Yes, we will give the docker-compose sample later.
- **Why another framework? Is Laravel or Symfony not enough?** Hmmmm, you know my motivation create this framework is just for fun and learn. So nothing can stop me to create something haha.
- **Why the name is Doitsu?** [Rian Cintiyo](https://github.com/riancintiyo) propose the name and I think that's very good name, so we continue with that. It's Japanese word that means Germany.
- **What do you use for doing routing?** We use Symfony Routing component.
- **What template engine do you use?** We use Twig template engine.
## Adding Alpine JS
- **There are 2 ways to add Alpine JS** :
> 1. Adding Alpine JS by including it from a `` tag
> 2. Importing it as a module<br>
#### **1. Adding Alpine JS from `<script>` tag.**<br> ####
You can add Alpine Js using CDN by adding it on **template/base.html.twig** file and place it before end of `</head>` markup like image bellow.
```html
<html>
<head>
...
<script defer src="https://cdn.jsdelivr.net/npm/alpinejs@3.x.x/dist/cdn.min.js">
...