Hoodie

The Offline First JavaScript Backend

README

hoodie


A generic backend with a client API for Offline First applications

Build Status Coverage Status Dependency Status devDependency Status

The Low-Profile Dog Hoodie Mascot

Hoodie lets you build apps without _thinking_ about the backend
and makes sure that they work great independent of connectivity.

This is Hoodie’s main repository. It starts a server and serves the client API.

A good place to start is our Tracker App.
You can play around with Hoodie’s APIs in the browser console and see how it
works all together in its simple HTML and JavaScript code.

If you have any questions come and say hi in our chat.

Setup


This setup is working for all operating system, testing on Windows 8, Windows 8.1, Windows 10, Mac and Linux.

Hoodie is a Node.js package. You need Node Version 4
or higher and npm Version 2 or higher, check your installed version with node -v and npm -v.

First, create a folder and a package.json file

  1. ```
  2. mkdir my-app
  3. cd my-app
  4. npm init -y
  5. ```

Next, install hoodie and save it as dependency

  1. ```
  2. npm install --save hoodie
  3. ```

Now start up your Hoodie app

  1. ```
  2. npm start
  3. ```

You can find a more thorough description in our Getting Started Guide.

Usage


hoodie can be used standalone or as a hapi plugin.
The options are slightly different. For the standalone usage, see Hoodie’s configuration guide.
For the hapi plugin usage, see Hoodie’s hapi plugin usage guide.

Testing


Local setup

  1. ```
  2. git clone https://github.com/hoodiehq/hoodie.git
  3. cd hoodie
  4. npm install
  5. ```

The hoodie test suite is run with npm test.

You can start hoodie itself by using npm start. It will serve the contents

Backers


Become a backer and show your Hoodie support!
undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined

Official Sponsors


Show your support for Hoodie and help us sustain our inclusive community. We will publicly appreciate your support and happy to get your word out as well, as long as it aligns with our Code of Conduct.
undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined undefined

License