Giter Club home page Giter Club logo

mnml's Introduction

MNML

What is this?

View the project page at http://mn-ml.cc

MNML is a starting point for prototyping responsive HTML5 SASS projects. Uses gulp to create a dev environment for rapidly prototyping sites.

Features

  • sass compilation
  • css minification
  • css linting
  • autoprefixer (automatically adds appropriate vendor prefixes)
  • browser reload on filesave
  • local server for serving a static site

Getting started

  • Create a new repo for your project on Github
  • In terminal run
    git clone [email protected]:mrmrs/mnml.git yourNewRepoName
    cd yourNewRepoName
    rm -rf .git
    git init
    git remote add origin [email protected]:yourUserName/yourNewRepoName.git
  • git remote -v will allow you to check that you have changed the remote origin correctly. The output should look like:
    origin [email protected]:yourUserName/yourNewRepoName.git (fetch)
    origin [email protected]:yourUserName/yourNewRepoName.git (push)

Dev environment

To set up a convenient dev environment run this at the root of mnml

npm install -g gulp browser-sync && npm install .

Then run

gulp

Gulp is a javascript task runner. It compiles sass, lints the compiled css, and sets up a livereload server so you can save your fingers from pressing ⌘+r

  • Once you add & commit files you are ready to publish run:
git push -u origin master

Directory structure

    mnml/
        ├── README.md
        ├── gulpfile.js
        ├── package.json
        ├── index.html                (386 bytes)
        ├── css
        │   └── i.css                 (2 kb minified - 1.2kb gzipped)
        └── sass                      CSS source
            ├── _normalize.scss
            ├── _variables.scss
            ├── _grid.scss
            ├── _type.scss
            ├── _styles.scss
            └── i.scss

Author

MRMRS

License

The MIT License (MIT)

Copyright (c) 2014 @mrmrs

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

mnml's People

Contributors

mrmrs avatar xiaogwu avatar

Watchers

 avatar  avatar  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.