Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashwani-rathee/firebase.jl
Julia's interface to the Firebase's REST API. Covers cloud firestore, cloud storage, firebase authenication, realtime database
https://github.com/ashwani-rathee/firebase.jl
api firebase firebase-jl firestore hacktoberfest julia wrapper
Last synced: 16 days ago
JSON representation
Julia's interface to the Firebase's REST API. Covers cloud firestore, cloud storage, firebase authenication, realtime database
- Host: GitHub
- URL: https://github.com/ashwani-rathee/firebase.jl
- Owner: ashwani-rathee
- License: mit
- Created: 2021-06-14T11:08:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-29T13:59:07.000Z (12 months ago)
- Last Synced: 2024-10-13T23:29:00.532Z (about 1 month ago)
- Topics: api, firebase, firebase-jl, firestore, hacktoberfest, julia, wrapper
- Language: Julia
- Homepage: https://ashwani-rathee.github.io/Firebase.jl/dev
- Size: 281 KB
- Stars: 31
- Watchers: 3
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Firebase.jl : Julia Firebase
| **Documentation** | **Build Status** | **Information** |
|:-:|:-:|:-:|
| [](https://ashwani-rathee.github.io/Firebase.jl/dev/) | [](https://travis-ci.com/Xh4H/Discord.jl) | [](https://discord.gg/5vAJyZsS) [](https://github.com/ashwani-rathee/Firebase.jl/blob/main/LICENSE) |
Firebase.jl is the solution for working with [Firebase](https://firebase.google.com/) with the [Julia programming language](https://julialang.org).
## Notes:
>Firebase isn't endorsing this project and hasn't built this project. So use it at your own discretion and risk.
# Installation
Stable Version
```julia
# Enter ']' from the REPL to enter Pkg mode.
pkg> add Firebase
```
Dev Version
```julia
using Pkg
# Enter ']' from the REPL to enter Pkg mode.
pkg> add https://github.com/ashwani-rathee/Firebase.jl.git
```
# Cloud Firestore
To fetch a document
```julia
using Firebase
Firebase.init("[FIREBASE_ADMIN_SDK].json") # just init() works too
# if you have multiple sdk key files, in your project make a firebase folder and put all key in that folder
Firebase.init()
```
Firebase.init() will look something like this:
```
julia> Firebase.init()
Choose your admin sdk key for use:
firebase/2.json
> firebase/fir-jl-457eb-firebase-adminsdk-40928-b1054bfad0.json
Project Admin SDK key is firebase/fir-jl-457eb-firebase-adminsdk-40928-b1054bfad0.json now!!
project_id: fir-jl-457eb
client_email: [email protected]
```
To get document or a collection:
```julia
res = get_request("/firebase_test/firebase_get") # document get
res = get_request("/firebase_test/firebase_get/firebase_get_collection") # collection fetch
```
To Update/Insert a document
```julia
init("[FIREBASE_ADMIN_SDK].json")
firestore_patch("/firebase_test/firebase_patch")
```
To get list of documents
```julia
init("[FIREBASE_ADMIN_SDK].json")
firestore_getdoclist("/firebase_test")
```
# Realtime Database
Initializing the realdb for the base url, reduces the effort later
```julia
realdbinit("https://fir-jl-457eb-default-rtdb.asia-southeast1.firebasedatabase.app")
Base Url set:"https://fir-jl-457eb-default-rtdb.asia-southeast1.firebasedatabase.app"
```
## GET - Reading Data
Data from your Realtime Database can be read by issuing an HTTP GET request to an endpoint. The following example demonstrates how you might retrieve a user's name that you had previously stored in Realtime Database.
```julia
julia> realdb_get("/firebase_test")
ulia> realdb_get("/firebase_test")
FINAL URL: "https://fir-jl-457eb-default-rtdb.asia-southeast1.firebasedatabase.app/firebase_test.json"
GET successful
Dict{String, Any} with 3 entries
```
## POST - Pushing Data
To accomplish the equivalent of the JavaScript push() method (see Lists of Data), you can issue a POST request.
A successful request is indicated by a 200 OK HTTP status code. The response contains the child name of the new data specified in the POST request.
```julia
julia> realdb_post("/firebase_test/firebase_new/","""{"hello":1}""")
FINAL URL: "https://fir-jl-457eb-default-rtdb.asia-southeast1.firebasedatabase.app/firebase_test/firebase_new.json"
POST successful
Dict{String, Any} with 1 entry:
"name" => "-McElRx3ZBP-l7pCF0LN"
```
## DELETE - Removing Data
You can delete data with a DELETE request
A successful DELETE request is indicated by a 200 OK HTTP status code with a response containing JSON null.
```julia
julia> realdb_delete("/firebase_test/firebase_new")
https://fir-jl-457eb-default-rtdb.asia-southeast1.firebasedatabase.app/firebase_test/firebase_new.json
DELETE successful
```
## PUT - Writing Data
You can write data with a PUT request.
A successful request is indicated by a 200 OK HTTP status code. The response contains the data specified in the PUT request.
```julia
julia> realdb_put("/firebase_test/firebase_new/","""{"hello":1}""")
FINAL URL: "https://fir-jl-457eb-default-rtdb.asia-southeast1.firebasedatabase.app/firebase_test/firebase_new.json"
PUT successful
Dict{String, Any} with 1 entry:
"name" => "-McElRx3ZBP-l7pCF0LN"
```
## Projects using this project
- [Volka-bot](https://github.com/ashwani-rathee/volka-bot.jl) - Bot provides various features like roles setup, rule embed setup, most importantly the ability to track the changes(commits) in github projects, new video releases on youtube and new blog posts after they have been subscribed in the server. To track the changes in the bot, bot check hourly for updates. Multiple git repos, youtube channels and blog subscriptions can be tracked.
## Reference
For further examples, guides and reference please refer to the documentation linked above.
## Contributing
Pull requests are welcome!
In most cases, it will be helpful to discuss the change you would like to make on [Discord](https://discord.gg/5vAJyZsS) before diving in too deep.
## Credits
Thanks to below mentioned projects as I used them as reference:
- Josh Day's project: https://github.com/joshday/Firestore.jl
- xximranxx's prokect: https://github.com/xximranxx/Firestore.jl