@databutton/firebase-types 1.5.0 → 1.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,34 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Databutton Firebase
|
|
2
|
+
|
|
3
|
+
This repo contains firestore types, functions and rules for Databutton.
|
|
4
|
+
|
|
5
|
+
## Contributing
|
|
6
|
+
|
|
7
|
+
This repo runs TypeScript and is a pure ESM project. This basically means that you have to write `import x from 'x';` and you can no longer write `const x = require('x');`
|
|
8
|
+
|
|
9
|
+
In addition, all imports needs to be relative paths and include file-ending (.js). This is also the case when importing TypeScript files because the imports are used after the TypeScript has been transpiled into JavaScript.
|
|
10
|
+
|
|
11
|
+
For more info, check out this [guide on writing pure ESM packages](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c)
|
|
12
|
+
|
|
13
|
+
### Developing
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
yarn install
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Running tests
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
yarn test:rules
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Linting
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
yarn lint
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Running locally
|
|
2
32
|
|
|
3
33
|
*Note:* You need Google Credentials
|
|
4
34
|
|
|
@@ -6,7 +36,7 @@
|
|
|
6
36
|
yarn shell
|
|
7
37
|
```
|
|
8
38
|
|
|
9
|
-
|
|
39
|
+
### Execute firebase scripts (for migration etch.)
|
|
10
40
|
|
|
11
41
|
Set up GOOGLE_APPLICATION_CREDENTIALS from the following guide: <https://firebase.google.com/docs/admin/setup#initialize-sdk> and add the environment variable to the file `<PROJECT_ROOT>/.env`
|
|
12
42
|
|