firebase-rest-api
v1.0.5
Published
[![npm version](https://badge.fury.io/js/angular2-expandable-list.svg)](https://badge.fury.io/js/angular2-expandable-list) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettie
Downloads
1
Readme
firebase-rest-api
Simple firebase interface that's build on typescript to ease usage of firebase services
Prerequisites
This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.
$ npm -v && node -v
6.4.1
v8.16.0
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.
Installation
Start with installing the package in to your project
npm i firebase-rest-api
Getting started
| Service | Description | | ------------------------ | --------------------------------------------------------------------------------------------- | | Firestore | NoSQL database built for global apps | | Storage (Soon) | Store and retrieve user-generated files like images, audio and video without server-side code | | Realtime Database (soon) | Store and sync data in real time |
If present, the request will be performed as soon as the component is mounted
Example:
import {FirebaseConfig} from 'firebase-rest-api';
const config = {
"project_id": "xxxxxxxxx-7e32a",
"private_key": "-----BEGIN PRIVATE KEY-----xxxx==\n-----END PRIVATE KEY-----\n",
"client_email": "firebasxxxxxxxxxxxxxxxxxxxxxxxxxxccount.com",
}
new FirebaseConfig(config);
Firestore Example:
import {Firestore} from 'firebase-rest-api';
const firestore=new Firestore();
firestore.createDocumentByPath("path","data");
firestore.createDocumentWithId("collection","uid","data");
firestore.createDocumentwithAutoId("collection","data");
firestore.readCollection("collection");
firestore.readDocumentById("collection","uid");
firestore.readDocumentByPath("path");
firestore.updateDocumentById("collection","uid","data");
firestore.updateDocumentByPath("path","data");
firestore.deleteDocumentById("collection","uid");
firestore.deleteDocumentByPath("path");
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Add your changes:
git add .
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :sunglasses:
Credits
TODO: Write credits
Built With
Typescript - Programming Langauge Nodejs - Server Environment NPM - Packages Firebase - Backend
.
About Author
@Initial work_ - Surendra Vadaparthy
@Linkedin_ - Connect
@Portfolio - View