Skip to content

Open-source status page, incident response and uptime monitoring

Improve dx (#474)

Thibault Le Ouaycf7d4147f2e4
diff --git a/apps/docs/developer-guide/setup-env.mdx b/apps/docs/developer-guide/setup-env.mdx
index ada77c158..ba8f575cd 100644
--- a/apps/docs/developer-guide/setup-env.mdx
+++ b/apps/docs/developer-guide/setup-env.mdx
@@ -277,7 +277,7 @@ configurations.
> like auth token invalid
3. Then download this file
- [ping_response\_\_v3](https://docs.openstatus.dev/dummy/ping_response__v3.csv)
+ [ping_response\_\_v5](https://raw.githubusercontent.com/openstatusHQ/openstatus/8d5c997aacd93becff2cf24ea1d08d33274d2c20/apps/docs/dummy/ping_response__v5.csv)
4. install the tinybird-cli
@@ -370,6 +370,41 @@ SQL >
```
+### Setting up the database
+
+We have an example database that you can use to get started. You can run it with
+the following command:
+
+```bash
+ turso dev --db-file openstatus-dev.db
+```
+
+It contains some dummy data that you can use to test the application. You still
+need to update the `tenant_id` in table `user` with your user account from
+Clerk.
+
+Do the following to get your `tenant_id`:
+
+![Sign up with clerk](/images/setup-env/clerk-step1.png)
+
+Then go in the user section:
+
+![Sign up with clerk](/images/setup-env/clerk-step2.png)
+
+Then copy the `tenant_id`:
+
+![Sign up with clerk](/images/setup-env/clerk-step3.png)
+
+then update the `tenant_id` in the database, for this you can use
+drizzle-studio:
+
+![Drizzle studio](/images/setup-env/drizzle-studio.png)
+
+```bash
+cd packages/db
+pnpm studio
+```
+
## Conclusion
Once you have collected all the necessary information, you should save it in the
diff --git a/apps/docs/dummy/ping_response__v5.csv b/apps/docs/dummy/ping_response__v5.csv
new file mode 100644
index 000000000..4e2a94b85
--- /dev/null
+++ b/apps/docs/dummy/ping_response__v5.csv
@@ -0,0 +1,4 @@
+latency;monitorId;pageId;region;statusCode;timestamp;url;workspaceId;cronTimestamp;metadata;message
+290;openstatusPing;openstatus;kix1;200;1695573755478;https://openstatus.dev/api/ping;openstatus;1695573646204;{};
+240;openstatusPing;openstatus;gru1;200;1695573755337;https://openstatus.dev/api/ping;openstatus;1695573646204;{};
+277;openstatusPing;openstatus;hkg1;200;1695573743935;https://openstatus.dev/api/ping;openstatus;1695573646204;{};
\ No newline at end of file
diff --git a/apps/docs/images/setup-env/clerk-step1.png b/apps/docs/images/setup-env/clerk-step1.png
new file mode 100644
index 000000000..4bed790d1
Binary files /dev/null and b/apps/docs/images/setup-env/clerk-step1.png differ
diff --git a/apps/docs/images/setup-env/clerk-step2.png b/apps/docs/images/setup-env/clerk-step2.png
new file mode 100644
index 000000000..82aca38a5
Binary files /dev/null and b/apps/docs/images/setup-env/clerk-step2.png differ
diff --git a/apps/docs/images/setup-env/clerk-step3.png b/apps/docs/images/setup-env/clerk-step3.png
new file mode 100644
index 000000000..b6a4f54ac
Binary files /dev/null and b/apps/docs/images/setup-env/clerk-step3.png differ
diff --git a/apps/docs/images/setup-env/drizzle-studio.png b/apps/docs/images/setup-env/drizzle-studio.png
new file mode 100644
index 000000000..64984daea
Binary files /dev/null and b/apps/docs/images/setup-env/drizzle-studio.png differ
diff --git a/openstatus-dev.db b/openstatus-dev.db
new file mode 100644
index 000000000..4d491fc2d
Binary files /dev/null and b/openstatus-dev.db differ