Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update README.md #113

Merged
merged 1 commit into from
Jan 29, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
TODO:

- eval use of `string_cache` for collection-names, document-names and map-keys
- eval use of `cachemap2` instead of `Arc<_>` at certain points

## Missing features

- [ ] Mimic transaction behaviour from cloud Firestore (mixed pessimistic and optimistic)
- [ ] Rest of the updates with Transforms
- [ ] Documentation
- [ ] ...
- [ ] Some of the updates with Transforms (such as Maximum and Minimum)
- [ ] Multiplexing listeners in a single stream (used by frontend Firestore SDK)
- [ ] Nearest neighbors search
- [ ] Some field filters (such as ArrayContainsAny and NotIn)
- [ ] Some API's that are not used by NodeJS SDK anymore (such as CreateDocument and Updatedocument)
- [ ] Explain options
- [ ] and many more... search for `unimplemented` to get the idea

And also missing a lot of documentation.

## Important to know

This is highly experimental software.
This is highly experimental software. We use this in our dev and CI enviroments to get better stability (and performance) while running our extensive unit test suites.

## How to use

### Prerequisites

```shell
brew install protobuf
```
Expand All @@ -25,13 +27,13 @@ brew install protobuf
Debug mode:

```shell
FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 cargo watch -cx run
FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 cargo run
```

Release mode:

```shell
FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 cargo watch -cx "run --release"
FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 cargo run --release
```

### Install
Expand Down