Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 2.54 KB

README.md

File metadata and controls

61 lines (36 loc) · 2.54 KB

Staple · GitHub license npm version

Staple is a JavaScript library that generates API's for your user interfaces in any NodeJS framework.

  • Develop Staple plugins, known as papers, once and use them in any NodeJS framework.
  • Eliminate the task of writing browser requests manually for your frontend apps. They will be automatically be generated by Staple, for you.
  • Prototype your application(s) without worrying about the backend, allowing you more time to focus on your UI.

Important notice

This project is still under heavy development and constantly improvement.

Installation

You need to install Node.js first, then install the tool globally using this command:

npm install -g staple

Still facing an issue? Check the Issues section or open a new issue.

The installation should be very smooth with Node.js v10 or lower. For newer versions, if the installation is failed, you may need to install development tools to build the C++ add-ons. Check node-gyp.

Getting Started

Get started by choosing the plugin you wish to add to your application and simply staple it using the paper command.

staple paper <name>

Usage

You can use the --help option to view the available commands and their options

staple <command> [options]

Examples

We have several examples on our website. Here is the first one to get you started:

staple paper users mailer

The main purpose of this repository is to continue to evolve Staple's core, making it faster and easier to use. Development of Staple happens in the open on GitHub, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Staple.

Moretape has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

License

Staple is MIT licensed.