instante/skeleton

Instante - instant Nette web application devstack

0.10.0 2016-09-26 15:25 UTC

Requires

• php: >=5.6.0
• instante/bootstrap: ~1.0
• instante/doctrine: ~1.1
• instante/require-js: ~1.1
• instante/ui: ~1.0.3
• nette/nette: ~2.4

Requires (Dev)

• instante/php-test-suite: @dev
• jakub-onderka/php-parallel-lint: ~0.6
• nette/tester: @dev

BSD-3-Clause, GPL-2.0, GPL-3.0

README

  ___           _              _                   //
 |_ _|_ __  ___| |_ __ _ _ __ | |_ ___       .∩∩.//
  | || '_ \/ __| __/ _` | '_ \| __/ _ \     .∩∩∩∩.
  | || | | \__ \ || (_| | | | | ||  __/    \     ) /
 |___|_| |_|___/\__\__,_|_| |_|\__\___|     \_____/

Create new application using Instante:

1. install skeleton (stable) using composer to current directory:

   composer create-project instante/skeleton .
   

   To install current development release, use

   composer create-project instante/skeleton . dev-master
   

2. customize this readme.md to correspond to your new project (and remove this "Create new application" section)

3. use bin/deployment/init-project.php to initialize your new project or customize composer.json, frontend/package.json, frontend/bower.json with your own project name, description, license etc.

4. initialize new git repository in project's folder:

   git init
   # on windows, use bin/git/setup-git.cmd to use LF line endings
   git add .
   git commit -m "initial commit"
   

Deploy application:

1. install dependencies by executing composer install from project root
2. Ensure that the database schema exists and is empty. Optionally, you may create one extra database schema for tests.
3. Ensure that the www server has write access to these folders
   • temp
   • log
4. setup local environment using bin/deployment/deploy-project.php

Develop/compile frontend:

install node.js, then use shell commands:

# setup
# install gulp and bower as global node.js module
your-project/frontend$ npm install -g gulp
your-project/frontend$ npm install -g bower

# install local grunt packages
your-project/frontend$ npm install

# install local bower components
your-project/frontend$ bower install

# start watchdog
your-project/frontend$ gulp

the watchdog starts to automatically optimize images and svgs, compile css, js and requirejs schema on any change.

More about frontend build process and folder structure at frontend/readme.md