# generator-comppgx

> > A Yeoman generator developed by Compro Technologies PVT LTD for generating awesome module or app boilerplates! Express, Mongoose , Mocha with scalability in mind and with Grunt and Bower sweetness..

Latest version **1.0.0** (published 2014-12-20) · 0 weekly downloads

## Install

```sh
npm install generator-comppgx
pnpm add generator-comppgx
yarn add generator-comppgx
bun add generator-comppgx
```

## 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.0.0 |
| Published | 2014-12-20 |
| First published | 2014-12-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | harish_compro |
| Maintainers | harish_compro |
| Keywords | yeoman-generator, compro-generator, comppgx-generator, comppgx |

## Links

- npm: https://www.npmjs.com/package/generator-comppgx
- npm.io page: https://npm.io/package/generator-comppgx

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ~0.4.0
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ~0.16.0

## Recent versions

- 1.0.0 (latest) — 2014-12-20

## README

# Compro Product Generator X (comppgx)

> A Yeoman generator developed by Compro Technologies PVT LTD for generating awesome module or app boilerplates! Express, Mongoose , Mocha with scalability in mind and with Grunt and Bower sweetness..

## Differences from similiar generators

The comppgx generator is built with scalability in mind.

### Great experience for developers

The goal with the comppgx generator is to create a great, easy to use and maintainable project structure and development environment for backend web development.

## Getting Started

### Install Yeoman

```bash
$ npm install -g yo
```

### Install the comppgx Generator Globally

```bash
$ npm install -g generator-comppgx
```

### Do the magic:

```bash
$ yo comppgx
```

### Run the app:

```bash
$ grunt serve
```
> **Don't forget that your mongodb server should already be running!** (if you chose MongoDB in the generator)


## What can the comppgx Generator do?

The comppgX Generator asks you what type of module you want to build, then you pick the parts you want from:

* REST API's - using [Express.js](http://expressjs.com)
* MongoDB - using [Mongoose](http://mongoosejs.com)

### What you'll get:

* A scalable directory structure (Todo list example included)
  - Not one directory per object type, which doesn't scale well, but instead one per REST mount point (backend).
* A fully configured Gruntfile with livereload, testing etc.
* Automounting of API routes using [exctrl](https://npmjs.org/package/exctrl)
* Backend unit testing with [Mocha](http://visionmedia.github.io/mocha/) and [Chai](http://chaijs.com/)!
* Subgenerators to easy add new API's, etc. (see Subgenerator section below)
* and more.. There's even more to come!

**Try it out!**

## Subgenerators

### comppgx:api

Usage:

```bash
$ yo comppgx:api "<you new api name here>"
```

The generator will ask if you want to create a new Mongoose model as well.

### More to come...

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