Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gamurs-group/fable-firebase-admin

Fable bindings for the firebase-admin npm package
https://github.com/gamurs-group/fable-firebase-admin

Last synced: 20 days ago
JSON representation

Fable bindings for the firebase-admin npm package

Awesome Lists containing this project

README

        

# Fable.FirebaseAdmin

Fable bindings for the [firebase-admin](https://www.npmjs.com/package/firebase-admin) npm package.

### Nuget Packages

Stable | Prerelease
--- | ---
[![NuGet Badge](https://buildstats.info/nuget/Fable.FirebaseAdmin)](https://www.nuget.org/packages/Fable.FirebaseAdmin/) | [![NuGet Badge](https://buildstats.info/nuget/Fable.FirebaseAdmin?includePreReleases=true)](https://www.nuget.org/packages/Fable.FirebaseAdmin/)

## Example

```
module Example

open Fable.FirebaseAdmin.Globals

// Initialise the Firebase admin SDK
FirebaseAdmin.admin.initializeApp()
|> ignore

```

## Development

### Building

Make sure the following **requirements** are installed in your system:

* [dotnet SDK](https://www.microsoft.com/net/download/core) 2.0 or higher
* [node.js](https://nodejs.org) 6.11 or higher
* [yarn](https://yarnpkg.com)
* [Mono](http://www.mono-project.com/) if you're on Linux or macOS.

Then you just need to type `./build.cmd` or `./build.sh`

To refer to your development copy from other projects before you release,
first set up a local nuget repository, then push the .nupkg file into it.
```
nuget sources add -name Local -source Local
nuget push -source Local src/bin/Release/*.nupkg
```

### Release

In order to push the package to [nuget.org](https://nuget.org) you need to add your API keys to `NUGET_KEY` environmental variable.
You can create a key [here](https://www.nuget.org/account/ApiKeys).

- Update RELEASE_NOTES with a new version, data and release notes [ReleaseNotesHelper](http://fake.build/apidocs/fake-releasenoteshelper.html).
Ex:

```
#### 0.2.0 - 30.04.2017
* FEATURE: Does cool stuff!
* BUGFIX: Fixes that silly oversight
```

- You can then use the Release target. This will:
- make a commit bumping the version: Bump version to 0.2.0
- publish the package to nuget
- push a git tag

`./build.sh Release`