https://github.com/startae/middleman-startae
A starter template ready to run on Netlify or Heroku. Comes with several helpers, partials and a nice basic structure to the HTML, Sass, Webpack and ES2015. Bottom line, a template that uses all the modern tools.
https://github.com/startae/middleman-startae
frontend heroku middleman netlify sass slim template
Last synced: 6 months ago
JSON representation
A starter template ready to run on Netlify or Heroku. Comes with several helpers, partials and a nice basic structure to the HTML, Sass, Webpack and ES2015. Bottom line, a template that uses all the modern tools.
- Host: GitHub
- URL: https://github.com/startae/middleman-startae
- Owner: startae
- License: mit
- Created: 2013-05-10T02:55:59.000Z (about 13 years ago)
- Default Branch: develop
- Last Pushed: 2021-07-12T17:27:21.000Z (almost 5 years ago)
- Last Synced: 2024-04-14T22:47:00.315Z (about 2 years ago)
- Topics: frontend, heroku, middleman, netlify, sass, slim, template
- Language: Ruby
- Homepage: https://middleman-startae.netlify.com
- Size: 14.6 MB
- Stars: 42
- Watchers: 10
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Middleman Startaê
[](http://www.startae.com)
[](http://www.startae.com)
[](https://heroku.com/deploy?template=https://github.com/startae/middleman-startae/tree/master)
[](https://app.netlify.com/start/deploy?repository=https://github.com/startae/middleman-startae)
## Key Features
* Middleman v4
* Ready to run on [Heroku](http://www.heroku.com) or [Netlify](http://www.netlify.com)
* [Livereload](http://livereload.com): automatically refresh your browser whenever you edit files
* [Slim](http://slim-lang.com): A lightweight templating engine
* [Webpack](https://webpack.js.org/): A module bundler for modern JavaScript applications
* [Sass](http://sass-lang.com): Syntactically Awesome Style Sheets
* [ITCSS](http://csswizardry.net/talks/2014/11/itcss-dafed.pdf): A sane, scalable and managed CSS architecture
* [PostCSS](http://postcss.org/): A tool for transforming CSS with JavaScript
* [Reset CSS](http://meyerweb.com/eric/tools/css/reset/): a reset stylesheet to reduce browser inconsistencies
* [itcsscli](http://itcsscli.github.io/itcsscli.com/): a tool for managing the ITCSS structure
* [Hagrid](https://github.com/fspoettel/hagrid): Simple but powerful flexbox-first grid
* [Babel](https://babeljs.io/): The compiler for writing next generation Javascript
* Language configuration
* Gzip
* Preconfigured partials
* Metatags helper
## Installation
### Basic installation
First, just clone the repository down to your local machine:
```
git clone http://github.com/startae/middleman-startae.git my_new_project
```
Install the JS dependencies by running:
```
yarn install
```
Install [Bundler](http://gembundler.com/), if you don't already have it:
```
gem install bundler
```
Finally, install the required gems with:
```
bundle install
```
### Running the app
Use the command ```middleman``` to do your local live development or ```middleman build``` to render your static file output to the ```/build/``` directory.
For the full Middleman documentation, visit the [Middleman website](http://middlemanapp.com/).
### Middleman Template
Middleman supports project templates. To use ```Middleman Startaê``` as a template, just follow these steps:
First install the middleman gem, so you can use the middleman command:
```
gem install middleman
```
Now you just have to pass the `startae/middleman-startae` to the init command.
```
middleman init my_new_project --template=startae/middleman-startae
```
## Build & Dependency Status
[](https://gemnasium.com/startae/middleman-startae)
[](/)
## Comments & Suggestions?
Just submit an [issue](https://github.com/startae/middleman-startae/issues).
For more help follow [Middleman's docs](https://middlemanapp.com/basics/install/).
[Middleman](http://middlemanapp.com/) is a static site generator based on Sinatra. Providing dozens of templating languages (Haml, Sass, Compass, Slim, CoffeeScript, and more). Makes minification, compression, cache busting, Yaml data (and more) an easy part of your development cycle.
Built with love by [Startaê](https://startae.com/).