jupl / btc-serverpack

Base project template with server extras

Home Page:http://jupl.github.io/btc/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Dependency Status

This is the base skeleton with server extras for the following derived project templates:

Visit the site for more information.

File Structure

├── app                     # Assets/code/styles for the client application
│   └── assets              # Static files copied without modification
├── generators              # Generators used by Scaffolt
├── jakelib                 # Unified set of tasks for development
├── public                  # Compiled client-side assets
├── server                  # Server configuration
│   ├── models              # Persistent server-side model configuration
│   ├── passport            # Passport integration
│   ├── routes              # Custom routes/proxies/etc. (server-side)
│   ├── browser-sync.js     # BrowserSync proxy setup
│   ├── config.js           # Configuration options
│   ├── index.js            # Starting point of server setup
│   ├── prerender.js        # Prerender middleware integration
│   └── session.js          # Session configuration
├── 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

  1. Download and install the following if you have not already:
  1. Download one of the starter projects from GitHub.
  2. 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 server:prod task. Use npm test to download all packages and run both the test:install and test:all tasks.

Server

Out of the box the server provides:

  • Serve static assets with support for HTML5 push state
  • Models and sessions with Mongoose
  • Authentication with Passport
  • Caching with Prerender.

Libraries

Core

Utilities

About

Base project template with server extras

http://jupl.github.io/btc/

License:MIT License


Languages

Language:JavaScript 100.0%