https://github.com/bitliner/generator-clap

Clap lets you generate an Express app, with ready to use REST-API to access data stored in MongoDb
https://github.com/bitliner/generator-clap

Last synced: about 21 hours ago
JSON representation

Clap lets you generate an Express app, with ready to use REST-API to access data stored in MongoDb

• Host: GitHub
• URL: https://github.com/bitliner/generator-clap
• Owner: bitliner
• License: mit
• Created: 2014-01-08T14:35:57.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2014-01-08T15:03:27.000Z (about 11 years ago)
• Last Synced: 2024-04-09T21:32:17.230Z (10 months ago)
• Language: JavaScript
• Size: 148 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
generator-clap

==============

A generator for [Yeoman](http://yeoman.io).

Clap lets you generate an Express app, with ready to use REST-API to access data stored in a MongoDb database instance.

It includes also grunt and grunt-forever.

To build the REST API layer, it uses the module [restful-mongo](https://github.com/bitliner/restful-mongo).

## Getting Started

### If you didn't yet, install Yeoman

```

$ npm install -g yo

```

### Install generator-clap

To install generator-clap from npm, run:

```

$ npm install -g generator-clap

```

### Run generator-clap

Create a subfolder where you want to generate the app

```

$ mkdir myAppName && cd $_

```

Finally, initiate the generator:

```

$ yo clap MyAppName

```

### Use the generated app

Run the generated app:

```

$ grunt run

```

Try the REST API:

* save an object to the database running 

```curl -X POST -H "Content-Type: application/json" -d  ```

```'{"username":"xyz","password":"xyz"}' http://localhost:3000/api/test/example```

* open the browser and access the url `http://localhost:3000/api/test/example?limit=1&fields=username`

### Do you want to use even AngularJS?

Just use [generator-angular](https://github.com/yeoman/generator-angular). Example:

Install generator-angular

```

$ npm install -g generator-angular

```

cd in the right folder

```

$ cd public && mkdir angular-app && cd $_

```

Run generator-angular

```

$ yo angular MyAngularAppName

```

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)