https://github.com/plumier/plumier

A TypeScript backend framework focuses on development productivity, uses dedicated reflection library to help you create a robust, secure and fast API delightfully.
https://github.com/plumier/plumier

backend decorators nodejs plumier reflection typescript

Last synced: about 2 months ago
JSON representation

A TypeScript backend framework focuses on development productivity, uses dedicated reflection library to help you create a robust, secure and fast API delightfully.

• Host: GitHub
• URL: https://github.com/plumier/plumier
• Owner: plumier
• License: mit
• Created: 2018-06-20T02:16:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-11-11T08:39:31.000Z (11 months ago)
• Last Synced: 2024-03-22T06:22:17.876Z (6 months ago)
• Topics: backend, decorators, nodejs, plumier, reflection, typescript
• Language: TypeScript
• Homepage: https://plumier.js.org
• Size: 22.3 MB
• Stars: 260
• Watchers: 10
• Forks: 15
• Open Issues: 24
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Plumier

Delightful Node.js Rest Framework

[![Build Status](https://github.com/plumier/plumier/workflows/ubuntu/badge.svg)](https://github.com/plumier/plumier/actions?query=workflow%3Aubuntu)

[![Build status](https://github.com/plumier/plumier/workflows/windows/badge.svg)](https://github.com/plumier/plumier/actions?query=workflow%3Awindows)

[![Coverage Status](https://coveralls.io/repos/github/plumier/plumier/badge.svg?branch=master)](https://coveralls.io/github/plumier/plumier?branch=master)

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)

[![npm](https://img.shields.io/npm/v/plumier/latest)](https://www.npmjs.com/package/plumier?activeTab=versions)

## Documentation 

Read the project documentation on https://plumier.js.org

## Contributing

To run Plumier project on local machine, some setup/app required

### App requirements

* Visual Studio Code (Recommended)

* Yarn (required)

### Local Setup

* Fork and clone the project `git clone` 

* Install dependencies by `yarn install`

* Run test by `yarn test`

### Debugging

Plumier already provided vscode `task` and `launch` setting. To start debugging a test scenario:

* Locate the test file and narrow the test runs by using `.only`

* Put breakpoint on any location you need on `.ts` file 

* On start/debug configuration select `Jest Current File` and start debugging