Permalink
Switch branches/tags
660/documentation-build-process first-timers-year fozy81-patch-1 fozy81-patch-2 gr2m-patch-1 greenkeeper/async-2.6.1 greenkeeper/async-pin-2.6.0 greenkeeper/browserify-pin-14.1.0 greenkeeper/good-8.0.0 greenkeeper/good-8.0.1 greenkeeper/good-8.1.0 greenkeeper/good-8.1.1 greenkeeper/h2o2-7.0.0 greenkeeper/h2o2-7.0.1 greenkeeper/h2o2-7.0.2 greenkeeper/h2o2-8.0.0 greenkeeper/h2o2-8.0.1 greenkeeper/h2o2-8.1.0 greenkeeper/h2o2-8.1.1 greenkeeper/h2o2-8.1.2 greenkeeper/hapi-17.0.0 greenkeeper/hapi-17.0.2 greenkeeper/hapi-17.1.0 greenkeeper/hapi-17.1.1 greenkeeper/hapi-17.2.0 greenkeeper/hapi-17.2.1 greenkeeper/hapi-17.2.2 greenkeeper/hapi-17.2.3 greenkeeper/hapi-17.3.0 greenkeeper/hapi-17.3.1 greenkeeper/hapi-17.4.0 greenkeeper/hapi-17.5.0 greenkeeper/inert-5.0.0 greenkeeper/inert-5.0.1 greenkeeper/inert-5.1.0 greenkeeper/lodash-4.17.1 greenkeeper/lodash-4.17.9 greenkeeper/nock-9.0.9 greenkeeper/nock-9.0.10 greenkeeper/nock-9.0.21 greenkeeper/nock-9.0.23 greenkeeper/nock-9.0.24 greenkeeper/nock-9.0.25 greenkeeper/nock-pin-9.0.8 greenkeeper/nock-pin-9.0.22 greenkeeper/npmlog-4.0.1 greenkeeper/proxyquire-2.0.0 greenkeeper/proxyquire-2.0.1 greenkeeper/rc-1.2.4 greenkeeper/rc-pin-1.2.3 greenkeeper/request-2.83.0 greenkeeper/request-2.84.0 greenkeeper/request-2.85.0 greenkeeper/request-2.86.0 greenkeeper/request-2.87.0 greenkeeper/request-pin-2.82.0 greenkeeper/request-pin-2.83.0 greenkeeper/semantic-release-15.0.0 greenkeeper/semantic-release-15.0.1 greenkeeper/semantic-release-15.0.2 greenkeeper/semantic-release-15.0.3 greenkeeper/semantic-release-15.1.2 greenkeeper/semantic-release-15.1.3 greenkeeper/semantic-release-15.1.4 greenkeeper/semantic-release-15.1.5 greenkeeper/semantic-release-15.1.6 greenkeeper/semantic-release-15.1.7 greenkeeper/semantic-release-15.1.8 greenkeeper/semantic-release-15.1.11 greenkeeper/semantic-release-15.3.0 greenkeeper/semantic-release-15.4.1 greenkeeper/semantic-release-15.4.2 greenkeeper/semantic-release-15.4.3 greenkeeper/semantic-release-15.4.4 greenkeeper/semantic-release-15.5.0 greenkeeper/semver-5.5.0 greenkeeper/semver-pin-5.4.1 greenkeeper/tap-12.0.0 greenkeeper/tap-12.0.1 greenkeeper/yargs-8.0.1 greenkeeper/yargs-9.0.1 greenkeeper/yargs-10.0.3 greenkeeper/yargs-10.1.1 greenkeeper/yargs-11.0.0 hoodie-client-legacy legacy master
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
59 lines (42 sloc) 2 KB

Welcome to Hoodie

Hoodie is a backend for web applications with a JavaScript API for your frontend. If you love building apps with HTML, CSS and JavaScript or a frontend framework, but dread backend work, Hoodie is for you.

Hoodie’s frontend API gives your code superpowers by allowing you to do things that usually only a backend can do (user accounts, emails, payments, etc.).

All of Hoodie is accessible through a simple script include, just like jQuery or lodash:

<script src="/hoodie/client.js"></script>

From that point on, things get really powerful really quickly:

// In your front-end code:
hoodie.ready.then(function () {
  hoodie.account.signUp({
    username: username,
    password: password
  })
})

That’s how simple signing up a new user is, for example. But anyway:

Hoodie is a frontend abstraction of a generic backend web service. As such, it is agnostic to your choice of frontend application framework. For example, you can use jQuery for your web app and Hoodie for your connection to the backend, instead of raw jQuery.ajax. You could also use React with Hoodie as a data store, or any other frontend framework or library, really.

Open Source

Hoodie is an Open Source project, so we don’t own it, can’t sell it, and it won’t suddenly vanish because we got aquired. The source code for Hoodie is available on GitHub under the Apache License 2.0.

How to proceed

You :doc:`could read up on some of the ideological concepts behind Hoodie <about/hoodie-concepts>`, such as noBackend and Offline First. These explain why Hoodie exists and why it looks and works the way it does.

If you’re more interested in the technical details of Hoodie, check out :doc:`How Hoodie Works <about/how-hoodie-works>`. Learn how Hoodie handles data storage, does syncing, and where the offline support comes from.

Eager to build stuff? Skip ahead to the :doc:`quickstart guide </guides/quickstart>`!