Browse files

my readme

  • Loading branch information...
1 parent be15b5e commit aa45f13f7bbeea782e97963a709c44226142011a @juzna committed Aug 2, 2012
Showing with 57 additions and 50 deletions.
  1. +57 −0 readme.md
  2. +0 −50 readme.txt
View
57 readme.md
@@ -0,0 +1,57 @@
+# Nette Sandbox with addons
+This is an experiment which evaluates how easy/hard it is to add addons to a sample Nette project.
+Please join the [discussion](http://forum.nette.org/cs/10875-nette-addons-konvence-a-architektura-aplikace).
+
+
+
+## Overview
+This is a sandbox/skeleton, from which you can start your projects with Nette Addons. It has the basic code needed to run them.
+
+We try to simplyfy addon instalation by automatig as many steps as possible. Previously, you would have to download the addon, extract it to correct place,
+ copy assets to www directory and register the addon in several places of your app. Now, with Composer's help, all those steps will be automated for you.
+ All you need is just to write down the *addon name* into `composer.json`, section *require* (like all other dependencies).
+
+
+
+## How it works?
+Supported Nette Addons are configured to `type=nette-addon` in `composer.json` file and Nette related info in section `extra`.
+Here is an [example](https://github.com/juzna/kdyby-CurlExtension/blob/juznovo/composer.json) of such addon.
+
+Custom installer copies the addon section from composer.json to `app/config/addons.neon` file which is then processed by the app.
+For more details, see [nette/addon-installer](https://github.com/juzna/nette-addon-installer) which does half of the hard work.
+
+
+
+## Try it yourself
+
+Clone and run this project:
+
+```
+git clone git://github.com/juzna/nette-addons-sandbox.git sandbox
+cd sandbox/
+chmod 0777 temp log
+mkdir -m0777 www/temp
+composer install
+```
+
+Now the sandbox should work, try it in your browser. To add an Addon, edit `composer.json` and add the addon. Example:
+```js
+{
+ ...
+ "require": {
+ "php": ">= 5.3.0",
+ "nette/nette": "2.0.*",
+ "JanMarek/WebLoader": "dev-juznovo",
+ "juzna/nette-visual-paginator": "@dev"
+ },
+ ...
+}
+```
+
+Run `composer update` to download newly configured dependencies. [nette/addon-installer](https://github.com/juzna/nette-addon-installer) should
+ handle all the hard work with setting up your addons and making them ready for you.
+
+
+
+## Issues
+There is common place for issues in the [nette/addon-installer](https://github.com/juzna/nette-addon-installer/issues) repository.
View
50 readme.txt
@@ -1,50 +0,0 @@
-Nette Framework Sandbox
-=======================
-
-The basic structure for your application.
-
-
-What is Nette Framework?
-------------------------
-
-Nette Framework is a powerful, component-based and event-driven framework
-for creating web applications and services in PHP 5.2 & 5.3. Nette Framework
-is designed with simplicity, speed and flexibility in mind. It allows developers
-to easy built better websites.
-
-Nette Framework focuses on security and performance and is definitely one of
-the safest and fastest PHP frameworks. Nette Framework support the latest
-technologies and approaches like AJAX, HTML5, SEO, DRY, KISS, MVC, etc.
-
-
-Requirements
-------------
-
-Nette Framework requires PHP 5.2.0 and/or 5.3.0.
-
-
-Installing
-----------
-
-Make directories 'sandbox/temp' and 'sandbox/log' writable.
-
-It is CRITICAL that file 'sandbox/app/config.neon' & whole 'sandbox/app', 'sandbox/log'
-and 'sandbox/temp' directory are NOT accessible directly via a web browser! If you
-don't protect this directory from direct web access, anybody will be able to see
-your sensitive data. See: http://nette.org/security-warning
-
-
-Documentation, Examples, Sandbox, Tools
----------------------------------------
-
-Nette Framework: homepage http://nette.org and repository http://github.com/nette/nette
-Sandbox, pre-packaged and configured project: http://github.com/nette/sandbox
-Examples repository: http://github.com/nette/examples
-
-
-License
--------
-
-This skeleton is part of the Nette Framework (http://nette.org). For the full
-copyright and license information, please view the file license.txt.
-For "Adminer" copyright and license information, please view it's source code.

0 comments on commit aa45f13

Please sign in to comment.