Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n0nag0n/fatfree-devtools
A web and cli admin to help with creating and maintaining Fat-Free Framework projects
https://github.com/n0nag0n/fatfree-devtools
admin composer devtools fat-free-framework fatfree fatfree-framework fatfreeframework php php7
Last synced: 2 days ago
JSON representation
A web and cli admin to help with creating and maintaining Fat-Free Framework projects
- Host: GitHub
- URL: https://github.com/n0nag0n/fatfree-devtools
- Owner: n0nag0n
- Created: 2020-07-23T19:46:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-13T17:21:45.000Z (11 months ago)
- Last Synced: 2024-10-20T14:43:22.308Z (25 days ago)
- Topics: admin, composer, devtools, fat-free-framework, fatfree, fatfree-framework, fatfreeframework, php, php7
- Language: PHP
- Homepage:
- Size: 653 KB
- Stars: 33
- Watchers: 6
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FatFree DevTools
This is a package that can aid the creation and management of your Fat-Free projects.
**Note: This is not tested against Windows environments for the time being.**
## Usage Video
I created a basic guide to help those that want to get started with this DevTools package.
[](https://youtu.be/2kU5S-byTwI)
[https://youtu.be/2kU5S-byTwI](https://youtu.be/2kU5S-byTwI)
## Installation
Installation is through Composer. If you don't have Composer, run the following command.
```
curl -s http://getcomposer.org/installer | php
```
### Globally (recommended)
```shell
composer global require n0nag0n/fatfree-devtools
# or sudo if you run into permissions issues because it's configured for restricted directories
sudo composer global require n0nag0n/fatfree-devtools
```
### Locally
```shell
composer require n0nag0n/fatfree-devtools --dev
```
## Usage
Basic usage is provided via the bin that is installed with Composer. Most of the default installations of Composer will use `vendor/bin/` and the root directory for bin files if you've installed this locally.
Otherwise, globally installations can just type `fatfree`. Make sure to place the `~/.composer/vendor/bin` directory in your `PATH` so the `fatfree` executable can be located by your system. As such, the remainder of this readme will only use `fatfree` instead of `vendor/bin/fatfree`.
### Web interface
There is a web interface that can be used instead of usage through CLI. It is recommended to use the web interface for beginners. To start up the web interface run the following command.
```shell
fatfree serve admin [--help [--port-8081 [--host=localhost]]]
```
Then follow the instructions output in your console for where to navigate to in your browser for the DevTools to display.
### Commands
This is a list of commands currently being used in the devtools helper.
#### Serve
This will serve your project using the PHP built-in web server.
```shell
fatfree serve [--help [--port-8080 [--host=localhost]]]
```
#### Clear Cache
This will clear your temp cache for you.
```shell
fatfree cache clear
```
#### Help
Provides a simple help dialog.
```shell
fatfree help
```
#### Version
Outputs the version.
```shell
fatfree version
```