Code Monkey home page Code Monkey logo

os-toolkit's Introduction

Odd Scenes Web Toolkit

A lightweight & fast frontend website build tool.

Built on the middleman framework. Includes a bunch of modern frontend tools.

Setup

  1. Install
  • Xcode CLI Tools: xcode-select --install
  • gem install middleman
  1. Create your site with dev server
  • Run middleman init project-name (project-name is folder name)
  • Navigate to project-name
  • Start up dev server: middleman server
  • Now you can make changes and build the site
  1. Build to production
  • When ready run middleman build
  • Project files to be used are located in /build folder
  1. Deploy with NOW
  • Ensure you have NodeJS installed: here
  • Run: npm install -g now
  • Navigate to build folder: cd build
  • Run now (verify email address on first time)
  • Your website will now be live at the URL given

You can also use the files in /build on your own server

Dependencies

  • Middleman: Static site generator
  • Bootstrap 4: UI toolkit
  • jQuery: JS functionality

Features

  • ERB templates
  • Components (partials)
  • ES6 + polyfill support
  • Live reloading
  • Minified, fast production build
  • SEO optimized
  • Sitemap generated with production build
  • Single build command will properly build all files
  • No server config/routing needed
  • Easily deploy to Now, Netlify or other one click systems

Meta Information Variables

  • Default <meta> tag properties are located in /data/meta.yml
  • If specified in template some of these values will be ignored

Google analytics

  • Default code for analytics is located in /javascripts/analytics.js

Built by http://oddscenes.com

os-toolkit's People

Contributors

jbrz0 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.