# hook

**Repository Path**: sillyrat/hook

## Basic Information

- **Project Name**: hook
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2017-06-09
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<img align="right" src="https://github.com/doubleleft/hook/blob/master/logo.png?raw=true" alt="hook" />

Welcome to hook
===

<a href="https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2Fdoubleleft%2Fhook%2Ftree%2Fmaster"><img src="https://www.herokucdn.com/deploy/button.png" height="20" ></a>
[![Build status](https://travis-ci.org/doubleleft/hook.svg?branch=master)](https://travis-ci.org/doubleleft/hook)
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/doubleleft/hook?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

hook is a RESTful, extendable Backend as a Service that provides instant backend
to develop sites and apps faster, with dead-simple integration for iOS, Android,
JavaScript and more.

**Requirements**: PHP 5.5+, or [PHP
5.3](http://doubleleft.github.io/hook-userguide/More/Deployment/#deploying-on-php-53).

- [Features](#features)
- [Installation](#installation)
- [How to use](#how-to-use)
- [Documentation](http://doubleleft.github.io/hook-userguide/)
- [Examples](https://github.com/doubleleft/hook-examples)

Features
---

- Multitenancy (same instance may be used for many apps)
- User authentication (register, login, reset password)
- Data persistance through `collections`
- Data storage through [many
  providers](http://doubleleft.github.io/hook-userguide/The-Basics/Configuration/#storage-providers)
- Real-time communication through [WAMP](http://wamp.ws) subprotocol (WebSockets).
- [Package
  management](http://doubleleft.github.io/hook-userguide/The-Basics/Configuration/#composer-packages) through composer

Installation
---

Run this command in your terminal to get the lastest
version:

```bash
curl -sSL https://raw.githubusercontent.com/doubleleft/hook/master/scripts/install.sh | bash
```

At the end of the process you should have
[hook](https://github.com/doubleleft/hook) and
[hook-cli](https://github.com/doubleleft/hook-cli.git) installed in your
machine.

How to use
---

Run the server locally:

```
hook server
```

Create a new application from the commandine:

```
hook app:new my-app --endpoint http://0.0.0.0:4665
```

It will output access keys to use in the front-end. Checkout this example using
[JavaScript](https://github.com/doubleleft/hook-javascript#how-to-use) frontend.

Take a look at the [documentation](http://doubleleft.github.io/hook-userguide/) for
more details.

Front-end Integration
---

Reduce the gap between backend and frontend development:

- [JavaScript](https://github.com/doubleleft/hook-javascript) ([docs](http://doubleleft.github.io/hook-javascript))
- [C# / Unity3D](https://github.com/doubleleft/hook-csharp)
- [Corona SDK](https://github.com/doubleleft/hook-corona-sdk)
- [iOS / OSX](https://github.com/doubleleft/hook-swift)
- [Java / Android](https://github.com/doubleleft/hook-android)
- [C++](https://github.com/doubleleft/hook-cpp)
- [PHP](https://github.com/doubleleft/hook-php) ([docs](http://doubleleft.github.io/hook-php))
- [Ruby](https://github.com/doubleleft/hook-ruby) ([docs](http://doubleleft.github.io/hook-ruby/))
- [Flash / ActionScript 3.0](https://github.com/doubleleft/hook-as3)

License
---

MIT.