node package manager
Stop wasting time. Easily manage code sharing in your team. Create a free org »

generaptr

npm Build Status Join the chat at https://gitter.im/generaptr/generaptr Coverage Status dependencies Greenkeeper badge

Generaptr is a node package that helps when starting up a project by generating boilerplate code for Express api.


Announcement

As of generaptr@1.2.0 this package would only hold the logic and core functionality of what was once generaptr. If you want to use the cli please use the new generaptr-cli package.


Table of Contents

  1. Documentation
  2. Minimum Requirements
  3. Installation
  4. Code of Conduct
  5. Contributing
  6. License
  7. References

Goal and Philosophy

Generaptr holds the core logic and functionality of generaptr-cli

Generaptr should ease the process of:

  • starting a new backend project
  • writing boilerplate crud operations
  • writing api specs

Documentation

Minimum Requirements

The package was developed under node 7.5 so a minimum requirement would be:

  • node >= v7.5.0
  • npm >= v3.10.10

Installation

npm install generaptr

Unit test

Unit test are written in Mocha and Assert. Please add a unit test for every new feature or bug fix. npm test to run the test suite.

Documentation

Add documentation for every API change. Feel free to send typo fixes and better docs!

License

Copyright (c) 2017 Darius Cupsa (twitter: @cupsadarius) Licensed under the MIT license.

References