Flatte-Web

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #llm #golang #android #rust #java #kubernetes #ios #mcp #openai #open-source

(★ 30)

Client-Side NOSql Firebase Realtime Database modeling and management system. (only with angularjs for now...)

Flatte-Web 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Welcome to Flatte
![Flatte Logo](https://flatte.maxabab.com/assets/images/logos/flatte%20logo_Header.png "Flatte Logo") BETA

Client-Side NOSql Firebase Realtime Database modeling and management system. (only with angularjs for now...)

Flatte manages your database for you with a manifest which is created by you.

## Benefits
* Flatte provides to create a NOSql database model.
* MySQL like transaction for Firebase. (If all conditions are passed, flatte sends the whole data to firebase.)
* Client side processing.
* Flatte handles copy records and external effects for you. No need to write everything in your application. (Denormalization)
* Flatte allows you to create field based functions.
* You can create your constants with predefined templates. (also with functions)
* You can apply filters to incoming values. (Such as uppercase, date format..)
* With [Flatte Manifesto Builder](https://flatte.maxabab.com), you can easily create and visualize your manifest.

### Attention!
This is a beta release. We have not finished all the tests yet.
Some functions may not work as expected.

**We do not recommend using flatte in your actual projects.**

> _For detailed explanation, please checkout our **[wiki](https://github.com/Flatte/Flatte-Web/wiki)**_

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

There are not many prerequisites required to build and run this project, but you'll need the following:

* Firebase
* AngularJs

## Flatte Manifest Builder 
Easy and free registration
[Flatte Manifesto Builder](https://flatte.maxabab.com)

## How to use
### Install
##### CDN
	<script type="text/javascript" src="https://cdn.rawgit.com/Flatte/Flatte-Web/1.0.1-beta.88/dist/flatte.min.js"></script>
##### Bower
	$ bower install flatte
If you don't want to use bower or cdn, you can manually download the latest version of [flatte.min.js](https://raw.githubusercontent.com/Flatte/Flatte-Web/master/dist/flatte.min.js).

### Basic Usage

Inject flatte in your angularjs module.
```javascript
angular.module('myApp',['mx.flatte']);
```

Set configurations.
```javascript
angular.module('myApp').run(['flatte',function(flatte){
  flatte.settings({
    debug: false,
    baseRef: "/",
    con: firebase,
    manifest: {},
    predefined: {
      ".true": true,
      ".false": false,
      ".null": null,
      ".timestamp": firebase.database.ServerValue.TIMESTAMP
    }
  });
}])
```

#### Understranding Flatte Manifest
Every node has "_q" and "childs" property. "_q" contains node's own options.
```javascript
flatt.settings().manifest = {
  "foo":{
    "_q":{},      // define action specifications of this node. (ID, saveValue, deleteValue, copy, externalEffect, function)
    "childs":{    // contains children of "foo" node
      "bar":{"_q":{},"childs":{}},
      "baz":{"_q":{},"childs":{}}
    }
  }
}
```
For more information about manifest structure and how to use, please visit our [wiki](https://github.com/Flatte/Flatte-Web/wiki)

![flatte.do process diagram](https://github.com/Flatte/Flatte-Web/raw/master/wiki/assets/flatte_do_process_diagram.jpg "flatte.do process diagram")

#### Example
Defined manifest in settings.
```json
{
  "customers": {
    "childs": {
      "customerID": {
        "_q": {
          "ID": true
        },
        "childs": {
          "firstName": {
            "_q": {
              "saveValue": {"filter": "uppercase"},
              "deleteValue": ".auth",
              "copy":[{"saveValue": "$","deleteValue": "null","path": "/contact/#customerID/firstName"}]
            }
          }
        }
      }
    }
  }
}
```
Sending save data to flatte.
```javascript
angular.module('myApp').controller('myCtrl',['flatte',function(flatte){
  flatte.do([{
    ref:"customer/-KrvGZuVwqwerty",
    data:{"firstName":"Elon","lastName": "Musk","twitter": "@elonmusk"}
  }]);
}]);
```

##### [Example fiddle](https://jsfiddle.net/micanose/pq8t5unx/)

##### Results
| Incoming data                                    | Recorded data                                    |
|--------------------------------------------------|--------------------------------------------------|
| customer/-KrvGZuVwqwerty/firstName:"Elon"         | customer/-KrvGZuVwqwerty/firstName:"**ELON**"     |
| customer/-KrvGZuVwqwerty/lastName:"Musk"         | customer/-KrvGZuVwqwerty/lastName:"Musk"         |
| customer/-KrvGZuVwqwerty/twitter:"@elonmusk"     | customer/-KrvGZuVwqwerty/twitter:"@elonmusk"     |
|                                                  | **contact/-KrvGZuVwqwerty/firsName:"Elon"**      |

![Flatte Example Photo](https://flatte.maxabab.com/assets/images/welcome/flatte_screen/full.png "Flatte Manifesto Builder")

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [Flatte Web Tags](https://github.com/Flatte/Flatte-Web/tags).

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Authors

* **Sezer Ekinci** - *Initial work* - [@micanose](https://github.com/micanose)
* **Kaan Ekinci** - *Initial work* - [@kaanekinci](https://github.com/kaanekinci)

See also the list of [contributors](https://github.com/Flatte/Flatte-Web/graphs/contributors) who participated in flatte.

## License
- Flatte is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
  - [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)

[![Flatte Manifest Builder 01 Explore A Demo Project](http://img.youtube.com/vi/g6rlvM0GuA8/0.jpg)](http://www.youtube.com/watch?v=g6rlvM0GuA8)

Flatte-Web

Flatte-Web 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Flatte-Web

Flatte-Web 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README