# generator-socket-ng1

> Boilerplate code for projects using AngularJS and socket.io.

Latest version **1.1.0** (published 2019-04-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-socket-ng1
pnpm add generator-socket-ng1
yarn add generator-socket-ng1
bun add generator-socket-ng1
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-04-08 |
| First published | 2019-03-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 28.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ramakrishna Pattnaik |
| Maintainers | rkpattnaik780 |
| Keywords | yeoman-generator, angular, socket, javascript, component, scaffold, generator |

## Links

- npm: https://www.npmjs.com/package/generator-socket-ng1
- Repository: https://github.com/rkpattnaik780/generator-socket-ng1
- Homepage: https://github.com/rkpattnaik780/generator-socket-ng1#readme
- Issues: https://github.com/rkpattnaik780/generator-socket-ng1/issues
- npm.io page: https://npm.io/package/generator-socket-ng1

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [mocha](https://npm.io/package/mocha.md) ^6.0.2
- [yosay](https://npm.io/package/yosay.md) ^2.0.2
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [yeoman-test](https://npm.io/package/yeoman-test.md) ^1.9.1
- [yeoman-assert](https://npm.io/package/yeoman-assert.md) ^3.1.1
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^3.2.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2019-04-08
- 1.0.5 — 2019-03-30
- 1.0.1 — 2019-03-27
- 1.0.0 — 2019-03-25

## README

# generator-socket-ng1

Generates the boiler-plate code for using AngularJS client with Socket.io in the backend to develop realtime projects.

## Getting started.

First, install [Yeoman](http://yeoman.io) and generator-socket-ng1 using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)) - if you need to manage multiple versions of node also consider [nvm](https://github.com/creationix/nvm).

Once node is installed, run this in your terminal.


```bash
npm install -g yo generator-socket-ng1
```

Then generate your new project:

```bash
yo generator-socket-ng1
```

## Directory structure

```
  |
  |-->public
  |     |--> index.html
  |     |--> images
  |     |       |--> favicon.ico
  |     |--> scripts
  |     |       |--> app.js
  |     |       |--> controllers
  |     |       |--> services
  |     |--> styles
  |     |       |--> app.css
  |     |--> views
  |--> app.js
  |--> LICENSE.md
  |--> package.json
  |--> README.md
  |--> .gitignore
  
```

## Sample Usage 

### Running the generator

![generator](./screenshots/socket_ng1_main.png)

### Running the server of generated app

![server](./screenshots/socket_ng1_run_server.png)

### Client app

![client](./screenshots/socket_ng1_client.png)

## Build Setup

``` bash
# install dependencies
npm install

# run linting tests
npm run pretest

# run all tests
npm test
```

## License

MIT © [Ramkrishna Pattnaik](https://github.com/rkpattnaik780)

---
_Source: https://npm.io/package/generator-socket-ng1 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
