firebase-firestorm

(★ 249)

Firebase Firestorm is an ORM for Firestore which can be used with Typescript.

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
- - caseconverter.html
  - collection.html
  - documentref.html
  - documentsnapshot.html
  - entity.html
  - fieldutils.html
  - firestoreserializer.html
  - geopoint.html
  - query.html
  - querybuilder.html
  - querysnapshot.html
  - timestamp.html
- - fieldconversiontype.html
  - fieldtypes.html
  - writetypes.html
- - documentchange.html
  - firestormdata.html
  - geopointdata.html
  - icollection.html
  - icollectionconfig.html
  - icollectionquery.html
  - idocumentref.html
  - idocumentrefconfig.html
  - idocumentrefmeta.html
  - idocumentsnapshot.html
  - ientity.html
  - ifieldconfig.html
  - ifieldmapconfig.html
  - ifieldmapmeta.html
  - ifieldmeta.html
  - ifieldwithentityconfig.html
  - ifieldwithentitymeta.html
  - ifireormconfig.html
  - igeopoint.html
  - igeopointconfig.html
  - igeopointmeta.html
  - iquery.html
  - iquerysnapshot.html
  - irepository.html
  - iserializedresult.html
  - istore.html
  - isubcollectionconfig.html
  - itimestamp.html
  - itimestampconfig.html
  - itimestampmeta.html
- globals.html
- index.html
- - documentRef.ts
  - field.ts
  - geoPoint.ts
  - index.ts
  - map.ts
  - rootCollection.ts
  - subCollection.ts
  - timestamp.ts
- - DocumentRef.ts
  - GeoPoint.ts
  - index.ts
  - Timestamp.ts
- - collection.types.ts
  - data.types.ts
  - enum.types.ts
  - field.types.ts
  - index.ts
  - store.types.ts
  - timestamp.types.ts
- - CaseConverter.ts
  - FieldUtils.ts
  - FirestoreSerializer.ts
  - index.ts
  - QueryBuilder.ts
- Collection.ts
- DocumentSnapshot.ts
- Entity.ts
- index.ts
- Query.ts
- QuerySnapshot.ts
- store.ts
- - Author.ts
  - AuthorPreferences.ts
  - Comment.ts
  - Post.ts
  - Reply.ts
- - configuration.spec.ts
  - querying-data.spec.ts
  - realtime-updates.spec.ts
  - writing-data.spec.ts
- - CaseConverter.spec.ts
  - Collection.spec.ts
  - DocumentRef.spec.ts
  - FieldUtils.spec.ts
  - FirestoreSerializer.spec.ts
  - GeoPoint.spec.ts
  - Query.spec.ts
  - QueryBuilder.spec.ts
  - QuerySnapshot.spec.ts
  - Timestamp.spec.ts
- bootstrap.spec.ts
- fixture.ts
.eslintrc
.gitignore
.remarkrc
.travis.yml
LICENSE.md
package-lock.json
package.json
README.md
service-account.json.enc
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/lmcq/firebase-firestorm

Downloads the entire project code from GitHub to your computer.

cd firebase-firestorm

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install firebase-firestorm

Downloads and installs the libraries listed in package.json.

npm install

Downloads and installs the libraries listed in package.json.

npm test

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.