Code Monkey home page Code Monkey logo

slimer's Introduction

Slimer

A suite of tools for working on Ghost and in the surrounding ecosystem.

It (will soon) provide a CLI tool for quickly starting new projects.

Slimer is capable of creating 4 different types of project:

  • Pkg: create a package inside a mono repo
  • Mono: start a new mono repo with lerna, just like the slimer repo
  • Module: a simple standalone node module
  • App: a standalone app, based on express

Install

Add me to your globals:

  • npm i -g @tryghost/slimer-cli

Usage

I aim to be easy to use, if you ever get stuck, try adding --help to a command.

  • slimer new <name>
  • Run slimer or slimer --help for full usage details

Develop

This is a mono repository, managed with lerna.

  1. git clone this repo & cd into it as usual
  2. yarn setup is mapped to lerna bootstrap
    • installs all external dependencies
    • links all internal dependencies

Run

  • yarn dev (or yarn slimer) are aliases for slimer
  • yarn link:cli will make your local dev version available globally as just slimer <command>
  • yarn unlink:cli will remove it again

Note: normally yarn link would work for this, but it's not working with the lerna repo for me.

Test

  • yarn lint run just eslint
  • yarn test run tests & then eslint

Publish

  • yarn ship is mapped to lerna publish and will publish any package that has changed.

Copyright & License

Copyright (c) 2018 Ghost Foundation - Released under the MIT license.

slimer's People

Contributors

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