Skip to content

Latest commit

 

History

History
120 lines (105 loc) · 4.22 KB

README.md

File metadata and controls

120 lines (105 loc) · 4.22 KB
Raw

slush-appkit Build Status

Provides a modular workflow to scaffold and build web applications, based on Slush.js, Gulp.js, and others.

@Deprecated: moved to Appfy

Requirement

  • Node 4+
  • Npm 2+
  • Bower 1.7+
  • Gulp 3.8+
  • Slush 1.1+

Dependencies

$ npm install -g bower
$ npm install -g gulp
$ npm install -g slush

Install

$ npm install -g slush-appkit

Usage

$ slush appkit

CLI

Command Line Interface

  • General
    • Show available tasks $ slush appkit --tasks
    • Show current version $ slush appkit --version
    • Create new application $ slush appkit
    • Serves both client and server $ slush appkit:serve
  • Client
    • Module
      $ slush appkit:client-module [moduleName]
    • Component
      $ slush appkit:client-component [moduleName] [componentName]
    • Directive
      $ slush appkit:client-directive [moduleName] [directiveName]
    • Filter
      $ slush appkit:client-filter [moduleName] [filterName]
    • Service
      $ slush appkit:client-service [moduleName] [serviceName]
    • Factory
      $ slush appkit:client-factory [moduleName] [factoryName]
    • Controller
      $ slush appkit:client-controller [moduleName] [controllerName]
  • Server
    • API endpoint
      $ slush appkit:server-api [endpoint]
    • Endpoint model
      $ slush appkit:server-model [endpoint] [modelName]
    • Endpoint controller
      $ slush appkit:server-controller [endpoint] [controllerName]
  • Environment
    • Serves client
      $ slush appkit:serve-client
    • Serves client in dist mode
      $ slush appkit:serve-client-dist
    • Serves API server $ slush appkit:serve-api
  • Deployment
    • build and deploy client
      $ slush appkit:client-deploy
    • build and deploy server
      $ slush appkit:server-deploy

Application Structure

├── README.md
├──.client.build                                <- client deploy
├──.server.build                                <- server deploy
├── gulpfile.ts                                 <- configuration of the gulp tasks
├── karma.conf.js                               <- configuration of the test runner
├── package.json                                <- dependencies of the project
├── protractor.conf.js                          <- e2e tests configuration
├── bin                                         <- deploy and build executables
├── server                                      <- source code of backend application
├── client                                      <- source code of frontend application
│   └── src
│       ├── app
│       │   └── core                            <- appkit core modules
│       │   │   ├── errors
│       │   │   ├── login
│       │   │   ├── page
│       │   │   ├── user
│       │   │   ├── utils
│       │   └── modules                          <- third-party modules
│       │   │   ├── home
│       │   │   │   ├── home.config.js
│       │   │   │   ├── home.component.js
│       │   │   │   ├── home.spec.js
│       │   │   │   ├── home.html
│       │   │   │   ├── home.css
│       │   └── themes         
│       │   │   ├── default
│       │   │   │   ├── theme.html
│       │   ├── index.less
│       │   ├── index.module.js                  <- main module
│       │   ├── vendor.less
│       ├── assets
│       └── index.html                           <- main template
└── .gitignore                                   <- ignored files