https://github.com/generaptr/generaptr

Generaptr is a node package that helps when starting up a project by generating boilerplate code for Express api.
https://github.com/generaptr/generaptr

api code generation hacktoberfest hacktoberfest2022 nodejs raml relational-databases schema

Last synced: 10 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/generaptr/generaptr
• Owner: generaptr
• License: mit
• Created: 2017-02-07T18:01:46.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-11-25T16:44:46.000Z (about 1 year ago)
• Last Synced: 2025-09-20T15:11:30.739Z (4 months ago)
• Topics: api, code, generation, hacktoberfest, hacktoberfest2022, nodejs, raml, relational-databases, schema
• Language: TypeScript
• Homepage: https://generaptr.github.io
• Size: 3.43 MB
• Stars: 16
• Watchers: 1
• Forks: 7
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
![](http://i.imgur.com/yCRAubA.png)

========

[![npm](https://badge.fury.io/js/generaptr.svg)](http://badge.fury.io/js/generaptr) [![Join the chat at https://gitter.im/generaptr/generaptr](https://badges.gitter.im/generaptr/generaptr.svg)](https://gitter.im/generaptr/generaptr?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Coverage Status](https://coveralls.io/repos/github/generaptr/generaptr/badge.svg?branch=master)](https://coveralls.io/github/generaptr/generaptr?branch=master) 

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgeneraptr%2Fgeneraptr.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fgeneraptr%2Fgeneraptr?ref=badge_shield)

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](https://github.com/generaptr/generaptr-cli) package.**

-------

## Table of Contents

1. [Documentation](#documentation)

2. [Minimum Requirements](#minimum-requirements)

3. [Installation](#instalation)

6. [Code of Conduct](#code-conduct)

7. [Contributing](#contributing)

8. [License](#license)

9. [References](#references)

## Goal and Philosophy

**`Generaptr`** holds the core logic and functionality of [generaptr-cli](https://github.com/generaptr/generaptr-cli)

 

**`Generaptr`** should ease the process of:

- starting a new backend project

- writing boilerplate crud operations

- writing api specs

## [Documentation](#documentation)



### [Minimum Requirements](#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](#instalation)



``` shell

npm install generaptr

```

**Unit test**

Unit test are written in [Mocha](https://mochajs.org/) and [Assert](https://nodejs.org/api/assert.html). 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](#license)



Copyright (c) 2017 Darius Cupsa (twitter: [@cupsadarius](https://twitter.com/cupsadarius))

Licensed under the MIT license.

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgeneraptr%2Fgeneraptr.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fgeneraptr%2Fgeneraptr?ref=badge_large)

## [References](#references)



* [RAML](http://raml.org)

* [Express.js](https://expressjs.com)