contribution-jhipster-uga / generator-jhipster-stripe-payment

JHipster module, this module integrate the payment plateform STRIPE to a Jhipster project. (It includes a web payment page and a JHipster payment entity)
MIT License
10 stars 4 forks source link
jhipster payment stripe stripe-api

generator-jhipster-stripe-payment

NPM version Build Status Dependency Status

JHipster module, this module integrate the payment plateform STRIPE to a Jhipster project.(It includes a web payment page and a JHipster payment entity)

Introduction

This is a JHipster module, that is meant to be used in a JHipster application. This will add a new payment page (located in yourURL/payments for examples if you are still developping: localhost:8080/payments): Payment Page

When a payment is successful, a popup will appear and a new payment entity will be created: Entity Page

Just click once on buy!

Please note that the 'receipt' field corresponds to the json file returned by the stripe api. It includes the receipt 'url'.

You can find a sample application using this generator here : Sample Application

Prerequisites

As this is a JHipster module, we expect you have JHipster and its related tools already installed:

You will also need a Stripe account:

For the generation, you will need to know your publishable and private Stripe key.

Installation

With Yarn

To install this module:

yarn global add generator-jhipster-stripe-payment

To update this module:

yarn global upgrade generator-jhipster-stripe-payment

With NPM

To install this module:

npm install -g generator-jhipster-stripe-payment

To update this module:

npm update -g generator-jhipster-stripe-payment

Usage

Now you need to start the JHipster generation using the following command:

yo jhipster-stripe-payment

If rewriting is necessary, please enter 'a' to rewrite all files.

Then start your application:

./mvnw

Additional information

Here is the dynamic view of the operation between the front end, back end and stripe api. Stripe dynamic view with JHipster

License

MIT © Contribution JHipster UGA Julien COURTIAL, Hugo GROS-DAILLON, Cédric LAFRASSE et Bastien TERRIER

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.