Git Product home page Git Product logo

revel-cli's Introduction

SUMMARY

This is a CLI to start or kill Revel projects.

  • start switch works only for JS projects. It will start all the selected repos concurrently and print all the logs in a single tab.
  • kill switch works with both JS and PY repos.

You can do these operation on a single or multiple projects at once.

Configuration

In the repo-list.mjs add JavaScript and Python repos.

  • Make sure to assign a full path to your local repo under cwd.

  • Check that the correct ports are assigned.

  • The default start script for each JS repo is npm start, but you can override it like so:

    	{
    		name: JS_REPO_NAMES.coord,
    		cwd: '/Users/levan/Projects/revel/oo-xt-frontend-coordinator',
    		port: 3000,
    		prefixColor: '#949B93',
          scripts: {
              start: "nvm start"
          }
    	}
  • If you are adding/removing a repo, make sure to keep JS_REPO_NAMES and PY_REPO_NAMES constants in const.js up to date.

Install

  • cd to the root dir and run npm ci && npm install -g

Uninstall

  • run npm uninstall -g revel

Usage

There are several ways to use the cli:

1) Select the action and repos

Run revel in your terminal and select the action and repos following the provided instructions.

2) Pass the action and select repos

  • Run revel --start or revel -s and select repos you'd like to start
  • Run revel --kill or revel -k and select repos you'd like to kill

3) Pass the action and repos

By default, you can pass any of the following args to the start/kill commands

  • Run revel -s --brand --common --coord --cs --xt --sd
  • Run revel -k --brand --common --coord --cs --xt --sd --mid --pybe --s3

Args correspond to the keys in the constants (JS_REPO_NAMES and PY_REPO_NAMES) inside the const.mjs file. Start command takes only keys of the JS_REPO_NAMES constant.

4) Start/Kill All

  • Run revel --start --all or revel -sa
  • Run revel --kill --all or revel -ka

revel-cli's People

Watchers

Levan Tsutskiridze 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.