Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 1.97 KB

README.md

File metadata and controls

75 lines (52 loc) · 1.97 KB

Static Base

Static Base is a useful starter kit to help you develop static sites (or prototypes) faster. It's a Middleman template that uses Slim, Sass, CoffeeScript, Autoprefixer and Livereload.

Installation & usage

# Clone the template (use depth param in order not to copy the history)
git --depth 1 clone [email protected]:fs/static-base.git ~/.middleman/fs-static-base

# Scaffold a project using static-base template
middleman init sitename --template=fs-static-base --skip-bundle
cd sitename
bin/setup

Development workflow

  1. Start server with bin/server
  2. Make changes in the source folder
  3. Check out results in the browser on http://localhost:4567

Manual deploy to Github Pages

Setup correct git remote and target host using environment variable:

export [email protected]:fs/static-base.git
export TARGET_HOST=example.com

Run bin/deploy

Semaphore integration

Test build

You can use Semaphore to make sure your source code will be built successfully.

Add these build commands:

bin/setup
bin/build

Deploy automatically to Github Pages

  • Deploy type: General
  • Deployment Strategy: Automatic
  • Deploy commands:
# git identity required for git push
git config --global user.email "[email protected]"
git config --global user.name "Semaphore"
export [email protected]:fs/static-base.git
export TARGET_HOST=example.com
bin/setup
bin/deploy
  • SSH key: specify your ssh key or unique per project.

Credits

Static Base is maintained by Timur Vafin. It was written by Flatstack with the help of our contributors.