https://github.com/kossnocorp/typesaurus-react
🦕 React/Preact Hooks for Typesaurus, type-safe Firestore ODM
https://github.com/kossnocorp/typesaurus-react
Last synced: 3 months ago
JSON representation
🦕 React/Preact Hooks for Typesaurus, type-safe Firestore ODM
- Host: GitHub
- URL: https://github.com/kossnocorp/typesaurus-react
- Owner: kossnocorp
- Created: 2020-01-13T07:03:39.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-29T02:43:10.000Z (over 1 year ago)
- Last Synced: 2024-05-21T12:28:50.457Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.45 MB
- Stars: 86
- Watchers: 6
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
🎉️ NEW: [Typesaurus X is out](https://blog.typesaurus.com/typesaurus-x-is-out/)!
# 🦕 Typesaurus React
React Hooks for [Typesaurus](https://github.com/kossnocorp/typesaurus), type-safe Firestore ODM.
→ [Read docs](https://typesaurus.com/integrations/react/)
## Installation
The library is available as an [npm package](https://www.npmjs.com/package/@typesaurus/react).
To install Typesaurus, run:
```sh
npm install --save @typesaurus/react typesaurus firebase firebase-admin
```
_Note that Typesaurus React has Typesaurus listed as a peer dependency, which also requires the `firebase` package to work in the web environment and `firebase-admin` to work in Node.js. These packages aren't listed as dependencies, so they won't install automatically with the Typesaurus package. Also, you'll need `react` installed._
## Changelog
See [the changelog](./CHANGELOG.md).
## License
[MIT © Sasha Koss](https://kossnocorp.mit-license.org/)