fuel / depot Goto Github PK

Fuel PHP Framework - Fuel v1.x dochub application. Get your info here!

PHP 64.98% CSS 19.98% JavaScript 14.16% ApacheConf 0.70% HTML 0.17%

demo fuel-v1 php

depot's Introduction

Fuel Depot

Description

Fuel Depot was designed to become the new documentation repository of the FuelPHP project. This repository contains the source code of the Depot application, written in FuelPHP offcourse.

It has become obsolete due to the decision to use PHPDocumentor for API documentation, and, for version 2, switch to markdown based documentation with a simple front controller that can be used locally, either with a local webserver or using PHP 5.4's built-in webserver.

It now serves as an example application, to see what FuelPHP can do. It does not have the most optimal application design, because the main goal was to show how to use as many features as possible.

FuelPHP

FuelPHP is a fast, lightweight PHP 5.3 framework. In an age where frameworks are a dime a dozen, We believe that FuelPHP will stand out in the crowd. It will do this by combining all the things you love about the great frameworks out there, while getting rid of the bad.

Credits

The login, authentication and registration code is based on the Ninjauth package by @philsturgeon.

Donate

Donate Here

Any donations would help support the framework and pay for software, development and hosting costs. We understand if you cannot, but greatly appreciate anything you can give.

depot's People

Contributors

Stargazers

Watchers

depot's Issues

Code Snippets

I think we can look at what @dhorrigan has with Scrapyrd and get it working within the depot.

Core features I was thinking of would be:

Allow users to save the snippets to their account
Allow users to "publish" the snippet, with a readme or some instructions attached
Allow other users to comment on the snippets
Allow other users to save snippets they like onto their account (for editing, etc) might want to retain the parent here to give proper credit to whomever the original author is

Port Cells Codebase

Port the existing cells codebase into the depot repo

Linking to source for individual methods on Github

Thought it'd be cool if clicking on items in the class reference would bring someone to the Github source line for that method...

For example clicking on the "get" method in Fuel -> Arr would bring you to https://github.com/fuel/core/blob/1.1/develop/classes/arr.php#L34

User management

Any access beyond read-only will require a login. Suggested is to use github accounts only for now.

The system needs to support groups, and ACL,s on groups. It needs an admin backend to be able to do the user administration. ACL's on authentication method might be a nice feature for future use.

Tutorials

Can we agree on a standard to write tutorials? I’m fan of Markdown, so naturally I’d vote for that.

Are the tutorials something that are going to be contributed via GitHub, or created on the site?

Tutorials

Can we agree on a standard to write tutorials? I’m fan of Markdown, so naturally I’d vote for that.

Are the tutorials something that are going to be contributed via GitHub, or created on the site?

Request for backbone.js + FuelPHP code snippets

Please post some sample code in your documentation on how to handle ajax requests and json responses from a Fuelphp controller when working with Backbone models and collections.

FuelPHP Code Documentation

The application needs an interface through which the development documentation can be managed.

Current plan is to use:

markdown for documentation text
form-based entry for class and method documentation (forces a strict format)
? a special markdown command to insert a class::method docblock in the generated html
version control on documentation
moderation, with ability to delete or rollback versions
release docs = a snapshot of all versions on a specific timestamp

Docs require user based access for modifcations, based on group membership with ACL's for 'no access', 'moderated access', or 'full access'.

A task should be written which will generate an HTML version of the docs, which can be used off-line, similar to the current documentation. It can also be zipped and presented for download on the main website.