Skip to content
🐶 The Offline First JavaScript Backend
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore(first-timers): don’t set hacktoberfest label Jan 19, 2018
bin
cli
docs
public fix: make default landing page responsive (#829) Dec 14, 2017
server refactor(plugin): pass route options to external plugins only Jun 13, 2017
test test(plugin): plugin that exports `{register}` function Jun 13, 2017
.gitignore chore(gitignore): docs/_build/ Feb 26, 2017
.textlintrc test: remove dead link testing - not working correctly Dec 22, 2017
.travis.yml
CONTRIBUTING.md chore(CONTRIBUTING): feature commit message convention Oct 20, 2017
LICENSE Update License (#841) Feb 22, 2018
README.md docs: 3rd party plugins Jun 13, 2017
package.json

README.md

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 from connectivity.

This is Hoodie’s main repository. It starts a server and serves the client API. Read more about how the Hoodie server works.

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 & JavaScript code.

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

Setup

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

mkdir my-app
cd my-app
npm init -y

Next install hoodie and save it as dependency

npm install --save hoodie

Now start up your Hoodie app

npm start

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

Usage

hoodie can be used standalone or as 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

git clone https://github.com/hoodiehq/hoodie.git
cd hoodie
npm install

The hoodie test suite is run with npm test. You can read more about testing Hoodie.

You can start hoodie for itself using npm start. It will serve the contents of the public folder.

Backers

Become a backer and show your Hoodie support!

Official Sponsors

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

License

Apache 2.0

You can’t perform that action at this time.