Giter Club home page Giter Club logo

skelmimosa's Introduction

skelmimosa

Mimosa needs skeletons! If you are using a cool suite of technologies and have a setup that you usually copy/paste around to get you started, then Mimosa needs you! Spend a little time and share your setup with other Mimosa users. See the Contribute section below.

Overview

This module adds commands for dealing with Mimosa skeletons. This module also contains the Mimosa skeleton registry file.

Skeletons are small starter Mimosa projects that include libraries (like, for instance, BootStrap or Backbone) and boilerplate code to jumpstart application development.

Mimosa skeletons are hosted on GitHub, so this module has a dependency on git being installed and being available at the command line from the location the skeleton commands are executed.

For more information regarding Mimosa in general, see http://mimosa.io.

Functionality

This module adds 3 new commands to Mimosa:

mimosa skel:new

This command creates a new skeleton from the registry. The command takes two arguments.

  • skeleton reference: either the name of the skeleton from the registry, the url of a github repo or a local system path.
  • folder to create: this parameter is optional. If it is not provided, the skeleton will be dropped in the current directory. If it is provided, the skeleton will be dropped in the named folder. The named folder will be created if it does not exist.

mimosa skel:list

This command lists all skeletons from the registry including the name, a description, the URL and some keywords for the skeleton.

mimosa skel:search

This command takes a keyword as input, like backbone, and writes out all the skeletons that have that keyword. Someday I hope Mimosa has enough skeletons that this command becomes a necessity to wade through them all. For now it is a nice to have.

Contribute

To contribute a skeleton, just submit a pull request or open an issue to get your skeleton added to the registry. I will curate the list but only barely. I don't care if you use Backbone or Ember or Angular or Batman, and I don't care how you organize your projects. All I might do is suggest tweaks to increase hotness.

Your skeleton can be as in depth as you'd care to make it. You can provide a nodejs server stack if you wish. Example code is welcome, boilerplate code is definitely encouraged. But don't submit an entire enterprise app. It shouldn't take someone using a skeleton an hour to slice out all the demo code before getting started with their own stuff.

skelmimosa's People

Contributors

dbashford avatar eisenbergeffect avatar kevin-buttercoin avatar

Watchers

 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.