sky-starter-kit v0.1.0

Sky Starter Kit

This project provides a starter-kit for every possible Front-End project using Gulp and Express.js.

• Express.js provide a strong structure for routing
• Gulp 4 (actually in alpha) is used as task manager
• Pug compilation to HTML
• PostCSS is used to compile the CSS (PreCSS, CSSNano and CSSNext are ready)
• Automatic Linter for PostCSS, JavaScript and Pug
• JavaScript Unit testing with Mocha with few examples

Features

Table of Contents

• Install
• Usage
• Contribute
• License

Install

To get you started you can simply clone the angular-seed repository and install the dependencies:

• git clone --depth 1 http://www.github.com/thedaviddias/sky-starter-kit/t (--depth 1 removes all but one .git commit history)

Update your Gulp globally

npm uninstall -g gulp

npm install -g gulp-cli

Running the Application with Docker

1. Install Docker Toolbox (http://docker.com/toolbox)
2. Start the Docker QuickStart Terminal
3. Navigate to this application's root folder in the terminal window
4. Run docker-compose build to build the images
5. Run docker-compose up to run the containers
6. Navigate to http://192.168.99.100:3000 in a browser

Usage

Tasks

...

Contribute

See the contribute file!

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

Git branching model

This repo branching model is inspired by Git Flow. Currently we have these types of branches:

• master - Latest release, stable
• develop - Main development, unstable
• release/ - Release archive
• feature/ - Specific features development
• example/ - Helpful examples
• hotfix/ - Emergency fixes for latest release

Read the Git Flow reference. This repo uses Semantic Versioning.

License

MIT © David Dias.