thoughtbot/proteus-middleman

This repository has been archived on 14/Dec/2017
Stars
133
Rank 272,547 (Top 6 %)
Language
CSS
Created about 10 years ago
Updated almost 7 years ago

thoughtbot/proteus-middleman

thoughtbot

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

[no longer maintained]

thoughtbot Middleman Starter

Note: This project is no longer being actively maintained. Check out our Middleman Template, instead.

About

This starter kit for Middleman follows the thoughtbot styleguide and includes our favorite front end tools.

About Middleman

Middleman is a static site generator built in Ruby. This makes it a great fit for projects that may end up as a Ruby on Rails app. Its minimalistic structure makes it very easy to work with, and includes support for deploying to Github Pages.

Includes

HAML: Simple template markup
Coffeescript: Write javascript with simpler syntax
Sass (LibSass): CSS with superpowers
Bourbon: Sass mixin library
Neat: Semantic grid for Sass and Bourbon
Bitters: Scaffold styles, variables and structure for Bourbon projects.
Middleman Live Reload: Reloads the page when files change
Middleman Deploy: Deploy your Middleman build via rsync, ftp, sftp, or git (deploys to Github Pages by default)

We also recommend Refills for prepackaged interface patterns and Proteus for a collection of useful starter kits to help you prototype faster.

Getting Started

Set up your project in your code directory

git clone https://github.com/thoughtbot/proteus-middleman.git your-project-folder
cd your-project-folder
git remote rm origin
git remote add origin your-git-url

Install dependencies:

bundle install

Run the server

bundle exec middleman

Deploy to Github Pages

bundle exec middleman deploy

Or install the Proteus gem and enjoy some shortcuts.

Directories

Stylesheets, fonts, images, and JavaScript files go in the /source/assets/ directory. Vendor stylesheets and JavaScripts should go in each of their /vendor/ directories.

Contributing

If you have problems, please create a GitHub Issue.

Have a fix or want to add a feature? Pull Requests are welcome!

Credits

thoughtbot Middleman Starter is maintained and funded by thoughtbot, inc. Thank you to all of the contributors!

License

Copyright © 2014–2015 thoughtbot, inc. thoughtbot Middleman Starter is free software, and may be redistributed under the terms specified in the license.

guides

A guide for programming in style.

bourbon

A Lightweight Sass Tool Set

paperclip

Easy file attachment management for ActiveRecord

laptop

A shell script to set up a macOS laptop for web and mobile development.

dotfiles

A set of vim, zsh, git, and tmux configuration files.

factory_bot

A library for setting up Ruby objects as test data.

administrate

A Rails engine that helps you put together a super-flexible admin dashboard.

neat

A fluid and flexible grid Sass framework

suspenders

A Rails template with our standard defaults, ready to deploy to Heroku.

til

Today I Learned

clearance

Rails authentication with email & password.

shoulda-matchers

Simple one-liner tests for common Rails functionality

Argo

Functional JSON parsing library for Swift

high_voltage

Easily include static pages in your Rails app.

rcm

rc file (dotfile) management

factory_bot_rails

Factory Bot ♥ Rails

shoulda

Makes tests easy on the fingers and the eyes

expandable-recycler-view

Custom Android RecyclerViewAdapters that collapse and expand

capybara-webkit

A Capybara driver for headless WebKit to test JavaScript web apps

gitsh

An interactive shell for git

Tropos

Weather and Forecasts for Humans

refills

[no longer maintained]

design-sprint

Product Design Sprint Material

bitters

Add a dash of pre-defined style to your Bourbon.

griddler

Simplify receiving email in Rails (deprecated)

trail-map

Trails to help designers and developers learn various topics.

appraisal

A Ruby library for testing your library against different versions of dependencies.

hotwire-example-template

A collection of branches that transmit HTML over the wire.

parity

Shell commands for development, staging, and production parity for Heroku apps

Runes

Infix operators for monadic functions in Swift

cocaine

A small library for doing (command) lines.

fishery

A library for setting up JavaScript objects as test data

flutie

View helpers for Rails applications

TBAnnotationClustering

Example App: How To Efficiently Display Large Amounts of Data on iOS Maps

vim-rspec

Run Rspec specs from Vim

climate_control

Modify your ENV

constable

Better company announcements

carnival

An unobtrusive, developer-friendly way to add comments

ruby-science

The reference for writing fantastic Rails applications

Curry

Swift implementations for function currying

pacecar

Generated scopes for ActiveRecord classes

hoptoad_notifier

Reports exceptions to Hoptoad

fake_stripe

A Stripe fake so that you can avoid hitting Stripe servers in tests.

json_matchers

Validate your JSON APIs

Swish

Nothing but Net(working)

superglue

A productive library for Classic Rails, React and Redux

paul_revere

A library for "one off" announcements in Rails apps.

stencil

Android library, written exclusively in kotlin, for animating the path created from text

Perform

Easy dependency injection for storyboard segues

upcase

Sharpen your programming skills.

testing-rails

Source code for the Testing Rails book

proteus

[no longer maintained]

Delta

Managing state is hard. Delta aims to make it simple.

foundry

Providing a new generation of vector assets and infinite possibility for the interactive web and mobile applications

limerick_rake

A collection of useful rake tasks.

shoulda-context

Shoulda Context makes it easy to write understandable and maintainable tests under Minitest and Test::Unit within Rails projects or plain Ruby projects.

backbone-support

terrapin

Run shell commands safely, even with user-supplied values

Superb

Pluggable HTTP authentication for Swift.

jack_up

[DEPRECATED] Easy AJAX file uploading in Rails

fistface

DIY @font-face web service.

squirrel

Natural-looking Finder Queries for ActiveRecord

sortable_table

Sort HTML tables in your Rails app.

write-yourself-a-roguelike

Write Yourself A Roguelike: Ruby Edition

pester

Automatically ask for a PR review

jester

REST in Javascript

complexity

A command line tool to identify complex code

kumade

Heroku deploy tasks with test coverage (DEPRECATED, NO LONGER BEING DEVELOPED)

FunctionalJSON-swift

capybara_discoball

Spin up an external server just for Capybara

tropos-android

Weather and Forecasts for Humans

ModalPresentationView

Remove the boilerplate of modal presentations in SwiftUI

react-native-typescript-styles-example

A template react native project for ergonomic styling structure and patterns.

vimulator

A JavaScript Vim simulator for demonstrations

bourne

[DEPRECATED] Adds test spies to mocha.

formulator

A form library for Phoenix

poppins

tailwindcss-aria-attributes

TailwindCSS variants for aria-* attributes

ghost-theme-template

A project scaffold for building ghost themes using gulp, node-sass, & autoprefixer

paperclip_demo

Paperclip demo application

middleman-template

The base Middleman application used at thoughtbot, ready to deploy to Netlify.

proteus-jekyll

[no longer maintained]

report_card

metrics and CI are for A students.

ios-sample-blender

Sample code for the Blending Modes blog post

yuri-ita

Create powerful interfaces for filtering, searching, and sorting collections of items.

baccano

[no longer maintained]

goal-oriented-git

A practical book about using Git

ios-on-rails

A guide to building a Rails API and iOS app

art_vandelay

Art Vandelay is an importer/exporter for Rails 6.0 and higher.

maybe_haskell

Programming without Null

redbird

A Redis adapter for Plug.Session

maintaining-open-source-projects

A successful open source project is not only one that is original, solves a particular problem well, or has pristine code quality. Those are but the tip of the iceberg, which we'll thoroughly dissect with this book.

templates

Documentation templates for open source projects.

FOMObot

A slack bot to help with FOMO.

BotKit

BotKit is a Cocoa Touch static library for use in iOS projects. It includes a number of helpful classes and categories that are useful during the development of an iOS application.

react-native-template

Template React Native project to be used with Cookiecutter

CombineViewModel

An implementation of the Model-View-ViewModel (MVVM) pattern using Combine.

flightdeck

Terraform modules for rapidly building production-grade Kubernetes clusters following SRE practices

design-for-developers-starter-kit

A starter project for design for developer students

mile_marker

Mark off HTML implementation expectations with clear signage