README.md

FireflyJS

The only ODM you will ever need for Firestore.

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Features
3. Getting Started
4. Documentation
5. Contributing
6. Contributors

About The Project

FireflyJS is an object document model(ODM) library for Firestore. It aims to ease the process of developing applications using Firestore by providing robust validation of data, exposing a multitude of ways to query, add, etc.

Built With

• TypeScript
• Jest
• Firebase

Features

• Define a schema for your data and add a multitude of operations before adding data to the database.
• Written completely in TypeScript. Get intelligent intellisense and speed up your development workflow.
• Easy to pick up, with a syntax inspired from popular libraries like Mongoose and Yup.
• Query data like a pro! With methods like findById, findOne, etc.
• Add and update data made easy and safe with proper validation, data transformation according to your defined schema and much more!

Getting Started

Coming Soon!

For now, you can refer tests for usage and examples as we are still developing the npm package.

Documentation

Inline documentation for all methods is available in the codebase. Documentation website is in the works. Stay Tuned :)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contributors

Thanks goes to these wonderful people (emoji key):

Aniket Biswas 💻 📖 🚧

Aryaman Grover 💻 📖 🚧

This project follows the all-contributors specification. Contributions of any kind welcome!