https://github.com/shotjs/shot-cli

Master of ceremonies for generators in the Shot CLI.
https://github.com/shotjs/shot-cli

cli expressjs mongodb mongoose nodejs shotjs socket-io

Last synced: 9 months ago
JSON representation

Master of ceremonies for generators in the Shot CLI.

• Host: GitHub
• URL: https://github.com/shotjs/shot-cli
• Owner: shotjs
• License: mit
• Created: 2016-12-29T05:44:20.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T01:11:11.000Z (over 3 years ago)
• Last Synced: 2025-09-06T08:52:59.732Z (10 months ago)
• Topics: cli, expressjs, mongodb, mongoose, nodejs, shotjs, socket-io
• Language: JavaScript
• Homepage: https://shotjs.github.io
• Size: 10.7 KB
• Stars: 2
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/contributing.md
  • License: license

Awesome Lists containing this project

README

          


> A fast streamline to build of realtime middleware layers in Node.js.

[![Travis Status](https://travis-ci.org/shotjs/shot.svg?branch=master)](https://travis-ci.org/shotjs/shot?branch=master)

[![Codacy Status](https://img.shields.io/codacy/grade/90207b2b022e439680e7a5c8d427654c/master.svg)](https://www.codacy.com/app/shotjs/shot/dashboard)

[![Dependencies Status](https://david-dm.org/shotjs/shot.svg)](https://david-dm.org/shotjs/shot)

[![Version Status](https://badge.fury.io/js/shot-cli.svg)](https://www.npmjs.com/package/shot-cli)

[![Download Status](https://img.shields.io/npm/dt/shot-cli.svg)](https://www.npmjs.com/package/shot-cli)

[![Gitter Chat](https://img.shields.io/badge/gitter-join_the_chat-4cc61e.svg)](https://gitter.im/shotjs/shot)

## Why it's awesome?

Shot is a fast streamline to build of realtime middleware layers in Node.js. No complexity. No stress. Using some technologies you love: Express, MonogoDB and Socket.IO. Specially designed for higher productivity to further enhance your time.

## Install

**Install with npm**

```bash

$ npm install shot-cli --global

```

**Install with Yarn**

```bash

$ yarn global add shot-cli

```

Run with npx (without installing)

```bash

$ npx shot-cli

```

## Usage

Create a new app using the command `shot init`, then install dependencies and run with `npm start`.

```sh

$ shot init new_app

$ cd new_app

$ npm start

```

*NOTE: Please make sure your MongoDB is running. For MongoDB installation guide see [this](https://docs.mongodb.org/v3.0/installation/).*

## Table of Contents

- [Getting Started](http://shotjs.github.io/#getting-started)

- [Tips](http://shotjs.github.io/#tips)

- [Support](http://shotjs.github.io/#support)

- [Examples](http://shotjs.github.io/#examples)

## Contributing

Want to contribute? Follow these [recommendations](https://github.com/shotjs/shot/blob/master/.github/contributing.md).

## License

Designed with ♥ by [CJ Patoilo](http://cjpatoilo.com). Licensed under the [MIT License](http://cjpatoilo.mit-license.org).