btc-chaplin
btc-chaplin copied to clipboard
Published
20 hours ago •
jupl
jupl
Chaplin project template
BTC Chaplin 0.12.0
This is a project template for Chaplin applications with CoffeeScript. Visit the site for more information.
File Structure
├── app # Assets/code/styles for the client application
│ ├── assets # Static files copied without modification
│ ├── controllers # Chaplin controllers
│ ├── models # Chaplin models and collections
│ ├── views # Chaplin views and collection views
│ ├── app.coffee # Chaplin application definition
│ ├── app.less # Application/page styling definition
│ ├── base.less # LESS variables and mixins for the application
│ ├── initialize.coffee # Chaplin views and collection views
│ ├── routes.coffee # Route definitions for Chaplin
│ └── utils.coffee # Utilities and helpers
├── generators # Generators used by Scaffolt
├── jakelib # Unified set of tasks for development
├── public # Compiled client-side assets
├── server # Server configuration
│ ├── browser-sync.js # BrowserSync proxy setup
│ └── index.js # Starting point of server setup
├── test # Test-related files
│ ├── code # Code tests that run with Karma
│ ├── site # Site tests that run with WebDriverJS
│ ├── mocha.opts # Default options for site testing
│ └── setup.js # Initialization for site testing
├── vendor # Additional 3rd party JS/CSS libraries
├── .editorconfig # EditorConfig definitions for coding styles
├── bower.json # Listing for Bower dependencies to download
├── brunch-config.js # Brunch app build configuration
├── karma.conf.js # Karma runner setup
└── package.json # Node project dependencies and configuration
Setup
- Download and install the following if you have not already:
- Node.js
- Git
- Jake (if developing)
- Platform SDKs (if using Cordova)
- MongoDB or service (if using Serverpack)
- Download one of the starter projects from GitHub.
- Navigate to the project directory and run the command
npm install.
Notes
npm start / npm test
One-line commands are provided for convenience as well for those that want to start running things as quickly as possible by installing depedencies automatically. Use npm start to download non-development packages and run the build:prod task. Use npm test to download all packages and run both the test:install and test:all tasks.
Server
A basic push state server serving static assets is included by default. You can expand/enhance the server as needed for services and to create a more ambitious application.
Libraries
Core
- BTC 0.10.4
jupl