Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aerogear-attic/aerogear-js-cookbook


https://github.com/aerogear-attic/aerogear-js-cookbook

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

AeroGear JS Cookbook
====================

The AeroGear JS cookbook is a list of recipes to quick start your AeroGear JS experience.

The goal of each of the recipes is to show you how easily you can use the different aspects of the AeroGear JS libraries and how it helps to achieve clean code.

| | Project Info |
| --------------- | ------------- |
| License: | Apache License, Version 2.0 |
| Build: | Node, Bower |
| Documentation: | https://aerogear.org/docs/specs/aerogear-js/ |
| Issue tracker: | https://issues.jboss.org/browse/AGJS |
| Mailing lists: | [aerogear-users](http://aerogear-users.1116366.n5.nabble.com/) ([subscribe](https://lists.jboss.org/mailman/listinfo/aerogear-users)) |
| | [aerogear-dev](http://aerogear-dev.1069024.n5.nabble.com/) ([subscribe](https://lists.jboss.org/mailman/listinfo/aerogear-dev)) |

### What you will need

* node
* bower
* git

### Cookbook Format

All recipes will follow the same format:

**Title**

Brief overview of the recipe

**Problem**

The recipies goals

**Solution**

How to solve the problem

**Working Code Example**

A small app to run.

Each app will be heavily documented on what is going on

### Recipes

To get the recipes, clone this repo:

$ git clone [email protected]:aerogear/aerogear-js-cookbook.git

$ cd aerogear-js-cookbook

## Cookbook apps

| App | Description | Data Manager | Push | Sync |
|-----|-------------|:------------:|:----:|:----:|
| [Food Recipes](food_recipes_data_manager) | Client-side storage example. | :heavy_check_mark: | :heavy_minus_sign: | :heavy_minus_sign: |
| [Simple Push](simplepush-example) | Introduction to SimplePush. | :heavy_minus_sign: | :heavy_check_mark: | :heavy_minus_sign: |
| [Unified Push](simplepush-unifiedpush-example) | Usage of AeroGear's SimplePush/Unified Push JS API | :heavy_minus_sign: | :heavy_check_mark: | :heavy_minus_sign: |
| [Chrome Push API](chrome-webpush-unifiedpush-example) | Usage of Chrome Push API with AeroGear Unified Push Server | :heavy_minus_sign: | :heavy_check_mark: | :heavy_minus_sign: |
| [Diff Sync - Ember](diff-sync-ember) | Ember app showcasing the use of Differential Synchronization client lib | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_check_mark: |
| [Diff Sync - Ionic/Angular](diff-sync-ionic) | Ionic/Angular app showcasing the use of Differential Synchronization client lib | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_check_mark: |
| [Diff Sync - Canvas](diff-sync-canvas) | Html canvas app showcasing the use of Differential Synchronization client lib | :heavy_minus_sign: | :heavy_minus_sign: | :heavy_check_mark: |

## Contributing Cookbook Recipes

TBD

## Documentation

For more details about the current release, please consult [our documentation](https://aerogear.org/docs/specs/aerogear-js/).

## Development

If you would like to help develop AeroGear you can join our [developer's mailing list](https://lists.jboss.org/mailman/listinfo/aerogear-dev), join #aerogear on Freenode, or shout at us on Twitter @aerogears.

Also takes some time and skim the [contributor guide](http://aerogear.org/docs/guides/Contributing/)

## Questions?

Join our [user mailing list](https://lists.jboss.org/mailman/listinfo/aerogear-users) for any questions or help! We really hope you enjoy app development with AeroGear!

## Found a bug?

If you found a bug please create a ticket for us on [Jira](https://issues.jboss.org/browse/AGJS) with some steps to reproduce it.