Skip to content

Commit 50c54d1

Browse files
committed
docs: add docs site
1 parent bcb4127 commit 50c54d1

28 files changed

+8713
-494
lines changed

.firebase/hosting.ZG9jc1xkaXN0.cache

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
favicon.svg,1690257490057,d16320a1e952e59e115b7c56623b16216219372442ab20416a70dde0b1ec629b
2+
moon.svg,1690257490059,8dac5161ab636f0b905196af58f91f593e637d0275943fb05165e26708dd99e0
3+
logo.svg,1690257490058,49958e466799267218f96f45988137a8af5ba146a1ecf721e435ef08078f5dd1
4+
sun.svg,1690257490059,9ec6a3f7bfedea113e56132b307dde9003d1da7dc8761072001826f851fa7ea0
5+
app/firebase-app/index.html,1690809482708,87ad067d7016bac4aef44e9d14f2ccc5040420a5e669f3abe853930fe1ea7440
6+
index.html,1690809482669,ca0cd28ce4cdc0b1f2901372f862cb0c5ba1829aa184b0cfbab0932d9b23c1ff
7+
auth/signed-in/index.html,1690809482702,ba7de4f8d66975055344fb427d3d8cb5d57632300144ef2bdc35a0311d7f9339
8+
api/index.html,1690809482704,9899661be4114e0b6b90e222fba71dbd31ee5ad5b2bbd98054ef990ec46a541d
9+
app/context/index.html,1690809482711,8adf2d0be54d28d7899af3c45cb8d98202f23a484110f104018e1196d76cbdb0
10+
auth/signed-out/index.html,1690809482695,2302afba53686afc80d1e0145be205c65dde132cab6c47430d3e977074a41405
11+
auth/user-store/index.html,1690809482699,ec128a017c427bc2615a47d004138174930d9b71fc80a1f95a022873fb9fff42
12+
firestore/doc-component/index.html,1690809482681,a4f8e375f94d495ddd920f41e577e00e32879a2a5f7033dfb04997f0f5bb64a4
13+
firestore/collection-component/index.html,1690809482673,8d43bbba261436788ec0a98c12fee2dc682415e5a6e495ad1346da4a2ed78476
14+
firestore/collection-store/index.html,1690809482677,0aa1618148c49602d249d468a4221a8049768d60e2e6074a8864ae81820477e3
15+
_astro/index.cdb7160f.css,1690809482617,c2dcc0b2829011716b11a8eded47c876d908598f42d2f8a579e33d548429fb99
16+
firestore/doc-store/index.html,1690809482684,50e445901d21913ccdd62bf75b0fe6e9398c3c47a433952c93eefe3748b1a092
17+
guide/todo/index.html,1690809482691,67528f611891adef0823f4e2c627c5b7961e049b4425e8d9d49224fec98fca19
18+
guide/start/index.html,1690809482688,8b50fdb85d41ba97b3ed29f06ae012421df57f38252444d80897eeeafddb8551
19+
logo.png,1690257490058,b79a00a4ab53fcd1d13b5bb6e83a06861f67f5550598185814876dee8ba2c975

.github/workflows/deploy-docs.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Deploy to Firebase Hosting
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
defaults:
9+
run:
10+
working-directory: ./docs
11+
12+
env:
13+
FIREBASE_TOKEN: ${{secrets.FIREBASE_TOKEN}}
14+
15+
jobs:
16+
build:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v2
20+
- uses: actions/setup-node@v2
21+
with:
22+
node-version: "18.x"
23+
- run: npm ci
24+
- run: npm run build
25+
- run: npm run deploy

.github/workflows/npm-publish.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Publish to NPM
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: actions/setup-node@v2
13+
with:
14+
node-version: "18.x"
15+
registry-url: "https://registry.npmjs.org"
16+
- run: npm ci
17+
- run: npm run build
18+
- name: Publish package to NPM
19+
run: npm publish
20+
env:
21+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/run-tests.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Run Playwright Tests
2+
3+
on:
4+
push:
5+
branches: [master, main]
6+
pull_request:
7+
branches: [master, main]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
- uses: actions/setup-node@v2
16+
with:
17+
node-version: 18
18+
- run: npm ci
19+
- run: npx playwright install --with-deps
20+
- run: npx playwright test
21+
- uses: actions/upload-artifact@v3
22+
if: always()
23+
with:
24+
name: playwright-report
25+
path: playwright-report/
26+
retention-days: 30

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A minimal, yet powerful library that puts realtime Firebase data into Svelte stores.
44

5-
Experimental! Do not use in production.
5+
[Documentation](https://sveltefire.fireship.io)
66

77
```svelte
88
<!-- 1. 🔥 Firebase App -->

0 commit comments

Comments
 (0)