Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoodiehq/hoodie
:dog: The Offline First JavaScript Backend
https://github.com/hoodiehq/hoodie
backend hoodie javascript offline-first
Last synced: 3 days ago
JSON representation
:dog: The Offline First JavaScript Backend
- Host: GitHub
- URL: https://github.com/hoodiehq/hoodie
- Owner: hoodiehq
- License: apache-2.0
- Created: 2012-06-25T10:44:38.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-07-27T11:21:44.000Z (5 months ago)
- Last Synced: 2024-12-02T20:06:37.621Z (10 days ago)
- Topics: backend, hoodie, javascript, offline-first
- Language: JavaScript
- Homepage:
- Size: 10.9 MB
- Stars: 4,408
- Watchers: 163
- Forks: 465
- Open Issues: 76
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - hoodiehq/hoodie - :dog: The Offline First JavaScript Backend (JavaScript)
- awesome-starred - hoodiehq/hoodie - :dog: The Offline First JavaScript Backend (javascript)
README
# hoodie
> A generic backend with a client API for Offline First applications
[](https://travis-ci.org/hoodiehq/hoodie)
[](https://coveralls.io/github/hoodiehq/hoodie?branch=master)
[](https://david-dm.org/hoodiehq/hoodie)
[](https://david-dm.org/hoodiehq/hoodie#info=devDependencies)
Hoodie lets you build apps [without _thinking_ about the backend](http://nobackend.org/)
and makes sure that they work great [independent of connectivity](http://offlinefirst.org/).
This is Hoodie’s main repository. It starts a server and serves the client API.
Read more about [How the Hoodie server works](server).
A good place to start is our [Tracker App](https://github.com/hoodiehq/hoodie-app-tracker).
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](https://github.com/hoodiehq/hoodie-app-tracker/tree/master/public).
If you have any questions come and say hi in our [chat](http://hood.ie/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](https://nodejs.org/en/) 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](https://docs.npmjs.com/files/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](http://docs.hood.ie/en/latest/guides/quickstart.html).
## Usage
`hoodie` can be used standalone or as a [hapi plugin](http://hapijs.com/tutorials/plugins).
The options are slightly different. For the standalone usage, see [Hoodie’s configuration guide](http://docs.hood.ie/en/latest/guides/configuration.html).
For the hapi plugin usage, see [Hoodie’s hapi plugin usage guide](http://docs.hood.ie/en/latest/guides/hapi-plugin.html).
## 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](test).
You can start hoodie itself by using `npm start`. It will serve the contents
of the [public folder](public).
## Backers
[Become a backer](https://opencollective.com/hoodie#support) and show your Hoodie support!
[](https://opencollective.com/hoodie/backer/0/website)
[](https://opencollective.com/hoodie/backer/1/website)
[](https://opencollective.com/hoodie/backer/2/website)
[](https://opencollective.com/hoodie/backer/3/website)
[](https://opencollective.com/hoodie/backer/4/website)
[](https://opencollective.com/hoodie/backer/5/website)
[](https://opencollective.com/hoodie/backer/6/website)
[](https://opencollective.com/hoodie/backer/7/website)
[](https://opencollective.com/hoodie/backer/8/website)
[](https://opencollective.com/hoodie/backer/9/website)
[](https://opencollective.com/hoodie/backer/10/website)
[](https://opencollective.com/hoodie/backer/11/website)
[](https://opencollective.com/hoodie/backer/12/website)
[](https://opencollective.com/hoodie/backer/13/website)
[](https://opencollective.com/hoodie/backer/14/website)
[](https://opencollective.com/hoodie/backer/15/website)
[](https://opencollective.com/hoodie/backer/16/website)
[](https://opencollective.com/hoodie/backer/17/website)
[](https://opencollective.com/hoodie/backer/18/website)
[](https://opencollective.com/hoodie/backer/19/website)
[](https://opencollective.com/hoodie/backer/20/website)
[](https://opencollective.com/hoodie/backer/21/website)
[](https://opencollective.com/hoodie/backer/22/website)
[](https://opencollective.com/hoodie/backer/23/website)
[](https://opencollective.com/hoodie/backer/24/website)
[](https://opencollective.com/hoodie/backer/25/website)
[](https://opencollective.com/hoodie/backer/26/website)
[](https://opencollective.com/hoodie/backer/27/website)
[](https://opencollective.com/hoodie/backer/28/website)
[](https://opencollective.com/hoodie/backer/29/website)
## Official Sponsors
Show your support for Hoodie and [help us sustain our inclusive community](http://hood.ie/blog/sustaining-hoodie.html). 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](http://hood.ie/code-of-conduct/).
[](https://opencollective.com/hoodie/sponsor/0/website)
[](https://opencollective.com/hoodie/sponsor/1/website)
[](https://opencollective.com/hoodie/sponsor/2/website)
[](https://opencollective.com/hoodie/sponsor/3/website)
[](https://opencollective.com/hoodie/sponsor/4/website)
[](https://opencollective.com/hoodie/sponsor/5/website)
[](https://opencollective.com/hoodie/sponsor/6/website)
[](https://opencollective.com/hoodie/sponsor/7/website)
[](https://opencollective.com/hoodie/sponsor/8/website)
[](https://opencollective.com/hoodie/sponsor/9/website)
[](https://opencollective.com/hoodie/sponsor/10/website)
[](https://opencollective.com/hoodie/sponsor/11/website)
[](https://opencollective.com/hoodie/sponsor/12/website)
[](https://opencollective.com/hoodie/sponsor/13/website)
[](https://opencollective.com/hoodie/sponsor/14/website)
[](https://opencollective.com/hoodie/sponsor/15/website)
[](https://opencollective.com/hoodie/sponsor/16/website)
[](https://opencollective.com/hoodie/sponsor/17/website)
[](https://opencollective.com/hoodie/sponsor/18/website)
[](https://opencollective.com/hoodie/sponsor/19/website)
## License
[Apache 2.0](LICENSE)