DEPRECATED: For up-to-date information see https://github.com/firephp/insight

---

Getting started with FirePHP 1.0

Stability: dev

This project contains everything you need to get started with hands-on learning about FirePHP 1.0 and includes examples on how to use FirePHP in various scenarios.

You can install this project (or view online at demo.firephp.org) to:

• Explore all FirePHP features with examples from popular open source projects (Not Yet Implemented)
• Learn how to install and configure FirePHP by example
• Learn how to integrate FirePHP into libraries by example (Not Yet Implemented)
• Learn how to integrate FirePHP into applications by example (Not Yet Implemented)
• Learn how to integrate FirePHP into frameworks by example (Not Yet Implemented)

Relevant third party projects are bundled meaning this project is quite large when downloading. If you are looking for documentation on how to install and use FirePHP, and you do not need in-depth examples, please refer to the official FirePHP documentation at: http://docs.sourcemint.org/firephp.org/firephp/1

NOTE: This project is not intended to showcase integrations with all or even many projects but rather focus on various types of use-cases. Reference integrations for third party projects will be published as individual projects. See Integrations.

Install

Assuming:

• You are running Apache or equivalent (in terms of URL rewrite support via .htaccess files)
• You are running PHP 5.3+
• /root/ is your document root
• http://localhost/ is mapped to your /root/

Via manual download and extraction:

1. Go to https://github.com/firephp/quickstart/tree/v0.1.0
2. Click on the Downloads button and download the .zip archive
3. When downloaded extract the archive to /root/
4. Open /root/ in a project or file explorer so you can launch files to view and edit
5. Browse to http://localhost/ using Firefox 4+. You should see a welcome page.

On a UNIX system with git installed:

cd /root/
git clone git://github.com/firephp/quickstart.git .

1. Open /root/ in a project or file explorer so you can launch files to view and edit
2. Browse to http://localhost/ using Firefox 4+. You should see a welcome page.

Examples

• /examples/BasicSetupConstants/ - How to use FirePHP in its simplest form.
• /examples/BasicSetupFiles/ - Minimal FirePHP setup using configuration files (RECOMMENDED).
• /examples/ZendFramework-1/ - How to use FirePHP with ZendFramework based on the ZendFramework Quick Start Application.

Support & Feedback

See: http://docs.sourcemint.org/firephp.org/firephp/1/-docs/OpenSource#support

Contribute

See: http://docs.sourcemint.org/firephp.org/firephp/1/-docs/OpenSource#contribute

Author

This project is maintained by Christoph Dorn.

Documentation License

Creative Commons Attribution-NonCommercial-ShareAlike 3.0

Copyright (c) 2007+ Christoph Dorn

Code License

NOTE: This project contains third party code licensed under various terms. The terms for respective third party projects can be found in /vendor/*/LICENSE.* files.

All other code is licensed as follows.

MIT License

Copyright (c) 2007+ Christoph Dorn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.