Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/SD10/Nora

Nora is a Firebase abstraction layer for FirebaseDatabase and FirebaseStorage
https://github.com/SD10/Nora

database firebase firebase-database firebasestorage networking open-source swift swift3

Last synced: 3 months ago
JSON representation

Nora is a Firebase abstraction layer for FirebaseDatabase and FirebaseStorage

Awesome Lists containing this project

README

        







codebeat badge


Build Status


Swift


Xcode


MIT


Contributions Welcome


Open Source Love

---

Nora is a Firebase abstraction layer for working with FirebaseDatabase and FirebaseStorage.

Stop spending all that time cleaning up your view controllers and trying to write reusable Firebase code.

Let Nora handle that for you. Your time is better spent on what you do best. Writing great Apps!

Simply put, working with Firebase just got whole lot easier.

---

## Installation

### [CocoaPods](https://cocoapods.org) Recommended

```rb
pod 'Nora'
```

## Example

### Working with FirebaseDatabase

After [setting up a target](https://github.com/SD10/Nora/blob/master/Documentation/Examples/DatabaseProviderExample.md) making requests is simple.

```swift

let database = DatabaseProvider()

database.request(.getUser(id: "1")) { result in
switch result {
case .success(let response):
let snapshot = response.snapshot
case .failure(let error):
print(error.localizedDescription)
}
}

```

### Database Response Decoding

Provide a JSON initializer for your custom types and easily convert the database response:

```swift

let database = DatabaseProvider()

database.request(.getUser(id: "1")) { result in
switch result {
case .success(let response):
let user = try? response.mapTo(User.init)
case .failure(let error):
print(error.localizedDescription)
}
}

```

---

### Working with FirebaseStorage

```swift

let storage = StorageProvider()
let avatarData = Data()
var meta = FIRStorageMetadata?

storage.request(.upload(avatarData, meta)) { result in
switch result {
case .success(_):
print("Upload Success!")
case .failure(let error):
print(error.localizedDescription)
}
}

```

---

## Documentation (In Progress)

[DatabaseTarget Documentation](https://github.com/SD10/Nora/blob/master/Documentation/Documentation/DatabaseTargetDocs.md)

[DatabaseProvider Documentation](https://github.com/SD10/Nora/blob/master/Documentation/Documentation/DatabaseProviderDocs.md)

---

## Get involved

You can contribute to this project in more ways than just code:

- Improving the README
- Improving Documentation
- Bug reporting
- New feature suggestions
- Answering questions

We really encourage everyone to get involved in open source.

Your feedback is always welcome and much appreciated!

REGARDLESS, of your level of experience.

You will never be put down for having an opinion. So take a chance, open a pull request, or submit that issue!

---

## Inspiration

This project was inspired and based off the [Moya](https://github.com/Moya/Moya) networking abstraction layer in Swift.

Check out their project if you're using traditional networking!

---

## License

Nora is released under an MIT license. See [LICENSE.md](https://github.com/SD10/Nora/blob/master/LICENSE.md) for more information.