https://github.com/octabytes/fireo-nodejs

Google Cloud Firestore modern and simplest convenient ORM package in NodeJs. FireO is specifically designed for the Google's Firestore
https://github.com/octabytes/fireo-nodejs

firebase fireo firestore-model google-cloud-firestore model nodejs odm orm

Last synced: 3 days ago
JSON representation

Google Cloud Firestore modern and simplest convenient ORM package in NodeJs. FireO is specifically designed for the Google's Firestore

• Host: GitHub
• URL: https://github.com/octabytes/fireo-nodejs
• Owner: octabytes
• License: apache-2.0
• Created: 2021-01-19T09:26:28.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-07-29T02:44:09.000Z (over 3 years ago)
• Last Synced: 2024-10-14T04:31:22.702Z (3 months ago)
• Topics: firebase, fireo, firestore-model, google-cloud-firestore, model, nodejs, odm, orm
• Language: JavaScript
• Homepage:
• Size: 239 KB
• Stars: 25
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


    


    


        A modern and simplest convenient ORM package in NodeJs.

        FireO is specifically designed for the Google's Firestore, it's more than just ORM.

        It implements validation, type checking, relational model logic and much more facilities.

    

    


        

            Get Started!

        

    

    




## Available in other language (Python)

1. FireO is available also in `python` [FireO Python](https://github.com/octabytes/FireO)

## Installation

```shell

npm install fireo

```

## Example Usage

```js

const {Model, Field} = require("fireo")

class User extends Model:

    name = Field.Text();

const u = User.init();

u.name = "Azeem Haider";

await u.save()

// Get user

user = await User.collection.get({key: u.key})

console.log(user.name)

```

## Documentation

Full documentation is available in the [FireO Doc](https://octabyte.io/fireo-nodejs/).

## Contributing

Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming

space for collaboration, and contributors are expected to adhere to the

[Contributor Covenant](https://github.com/octabytes/fireo-nodejs/blob/master/CODE_OF_CONDUCT.md) code of conduct.

1. Fix bug or add new features

2. Write tests for your functionality

3. Mention in [Documentation](https://github.com/octabytes/fireo-nodejs/tree/gh-pages), what you has done and how other can use it

## License

This is official [FireO](https://github.com/octabytes/fireo-nodejs) Repository. Powered by [OctaByte](https://octabyte.io)

Licensed under [Apache License 2.0](https://github.com/octabytes/fireo-nodejs/blob/master/LICENSE)