Giter Club home page Giter Club logo

hoodie-plugin-hello-world's Introduction

hoodie-plugin-hello-world

A sample Hoodie plugin

This Hoodie plugin is a great starting point if you want to create an own Hoodie plugin. It extends the hoodie client API, it defines a server route and a UI which can be accessed at /hoodie/hello-world.

Usage

First, install the plugin as dependency of your Hoodie app

npm install --save @hoodie/plugin-hello-world

Then add it the hoodie.plugins array in your app’s package.json file. If you like, you can change the default greeting and name in hoodie.app.helloWorld.greeting and hoodie.app.helloWorld.name.

{
  "name": "your-hoodie-app",
  ...
  "hoodie": {
    "plugins": ["@hoodie/plugin-hello-world"],
    "app": {
      "helloWorld": {
        "greeting": "Bonjour",
        "name": "le monde"
      }
    }
  }
}

You can now start your app with npm start and access the hello world form at localhost:8080/hoodie/hello-world.

Local setup

This plugin has hoodie as devDependency. The idea is that plugins can be started just like apps. Simply git clone this repository, run npm install and then npm start.

This plugin has no tests yet, but it would be nice to add some soon, so that plugin authors get a good blueprint which includes tests for their own plugins. See #11

License

Apache 2.0

hoodie-plugin-hello-world's People

Contributors

gr2m avatar greenkeeper[bot] avatar labaikie avatar lowprofiledog avatar

Watchers

Fred Guth avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.