-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
75a2f66
commit 1c1dfd1
Showing
2 changed files
with
59 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
Welcome to bechdel.io | ||
===================== | ||
|
||
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: | ||
|
||
.. code:: html | ||
|
||
<script src="/hoodie/client.js"></script> | ||
|
||
From that point on, things get really powerful really quickly: | ||
|
||
.. code:: javascript | ||
// 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>`! |