aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorWilly Micieli <micieli@laposte.net>2019-08-19 10:52:57 +0200
committerWilly Micieli <micieli@laposte.net>2019-08-19 10:52:57 +0200
commit8ac1ca2debb513a13b4ac2c48840d70520fb4b7a (patch)
treee546a1cd76d25317c9b09c35553c60668ca80783 /README.md
parent0f7266d2955724f380cb5e0c2f67f57d838d1c8d (diff)
downloadshaolin-8ac1ca2debb513a13b4ac2c48840d70520fb4b7a.zip
shaolin-8ac1ca2debb513a13b4ac2c48840d70520fb4b7a.tar.gz
add missing requirement
Diffstat (limited to 'README.md')
-rw-r--r--README.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9674536
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+* **Route management**
+ * Create a new route
+ * `php shaolin route:add`
+ * Show routes
+ * `php shaolin route:list`
+ * Search a route
+ * `php shaolin route:find`
+ * Remove a route
+ * `php shaolin route:destroy`
+ * Update a route
+ * `php shaolin route:update`
+ * Create route base
+ * `php shaolin route:generate`
+* **Code generation**
+ * Create a controller
+ * `php shaolin make:controller $name`
+ * Create a view
+ * `php shaolin make:view $name [$dir]`
+ * Create a model
+ * `php shaolin make:model $model $table`
+ * Create a middleware
+ * `php shaolin make:middleware $name`
+* **Database**
+ * Create migration and seeding
+ * `php shaolin db:add $table`
+ * Clean database (drop all tables)
+ * `php shaolin db:clean`
+ * Dump database
+ * `php shaolin dump`
+ * Migrate database
+ * `php shaolin migrate`
+ * Rollback last migration
+ * `php shaolin rollback`
+ * Seed database
+ * `php shaolin seed`
+* **Email**
+ * Generate dkim key (used to sign email)
+ * `php shaolin dkim:generate`
+
+* **Mode**
+ * Turn application in maintenance mode
+ * `php shaolin down`
+ * Turn application in production mode
+ * `php shaolin up`
+
+* **Controllers**
+ * [Available methods](https://git.fumseck.eu/cgit/imperium/tree/imperium/App.php)
+ * [Available helpers](https://git.fumseck.eu/cgit/imperium/tree/helpers)
+
+* **helpers**
+ * Create an admin helper
+ * Edit the `admin.php` inside the `app/Helpers` directory
+ * Create a web helper
+ * Edit the `web.php` inside the `app/Helpers` directory
+
+ * Example
+
+ ```php
+ if(!function_exist('helper'))
+ {
+ function helper()
+ {
+
+ }
+ }
+ ``` \ No newline at end of file