Skip to content

Open-source status page, incident response and uptime monitoring

🔥 improve dx (#1170)

Thibault Le Ouay0e97a434c969
diff --git a/README.md b/README.md
index f90397099..905d69b5c 100644
--- a/README.md
+++ b/README.md
@@ -88,47 +88,46 @@ Made with [Contrib.rocks](https://contrib.rocks)
- [Node.js](https://nodejs.org/en/) >= 20.0.0
- [pnpm](https://pnpm.io/) >= 8.6.2
+- [Bun](https://bun.sh/)
+- [Turso CLI](https://docs.turso.tech/quickstart)
### Setup
1. Clone the repository
- ```sh
- git clone https://github.com/openstatushq/openstatus.git
- ```
+```sh
+git clone https://github.com/openstatushq/openstatus.git
+```
2. Install dependencies
- ```sh
- pnpm install
- ```
+```sh
+pnpm install
+```
-3. Set up your .env file
+3. Initialize the development environment
- From `apps/web` and `packages/db`, you will find .env.example. Create your
- own copy.
+Launch the database in one terminal:
-4. Follow the steps to run your sqlite database locally inside of
- [README.md](https://github.com/openstatusHQ/openstatus/blob/main/packages/db/README.md)
+```sh
+turso dev --db-file openstatus-dev.db
+```
-5. Start the development with the below command
+In another terminal, run the following command:
- ```sh
- pnpm dev
- ```
+```sh
+pnpm dx
+```
- It will:
+4. Launch the web app
- - run the web app on port `3000`
- - run the api server on port `3001`
- - run the docs on port `3002`
+```sh
+pnpm dev:web
+```
-6. See the results:
+5. See the results:
- open [http://localhost:3000](http://localhost:3000) for the web app
-- open [http://localhost:3001/ping](http://localhost:3001/ping) for the api
- server health check
-- open [http://localhost:3002](http://localhost:3002) for the docs
### Videos
diff --git a/apps/docs/src/content/docs/contributing/getting-started.mdx b/apps/docs/src/content/docs/contributing/getting-started.mdx
index 137df6899..0a0f76e77 100644
--- a/apps/docs/src/content/docs/contributing/getting-started.mdx
+++ b/apps/docs/src/content/docs/contributing/getting-started.mdx
@@ -2,48 +2,46 @@
title: Getting Started
---
-import { Aside } from "@astrojs/starlight/components";
-
-<Aside>WIP</Aside>
## Setup
-1. Clone the repository and open the created directory
+1. Clone the repository
- ```sh
- git clone https://github.com/openstatushq/openstatus.git
- cd openstatus
- ```
+```sh
+git clone https://github.com/openstatushq/openstatus.git
+```
2. Install dependencies
- ```sh
- pnpm install
- ```
-
-3. Database setup
-
-We are using Turso for the database to make it work locally you need to install
-it and run it.
-
-If you are on a mac install it with [Homebrew](https://brew.sh/)
+```sh
+pnpm install
+```
+3. Initialize the development environment
-Here is the official Turso
-[installation guide](https://docs.turso.tech/reference/turso-cli)
+Launch the database in one terminal:
-4. Install Bun
-All the up to date information are on the official [Bun website](https://bun.sh/)
+```sh
+turso dev --db-file openstatus-dev.db
+```
-4. Set up the dev environment
+In another terminal, run the following command:
```sh
- pnpm dx
+pnpm dx
```
-5. Start the development server
+
+4. Launch the web app
```sh
- pnpm dev:web
+pnpm dev:web
```
-6. Open your browser and navigate to [http://localhost:3000](http://localhost:3000)
\ No newline at end of file
+It will:
+
+- run the web app on port `3000`
+
+5. See the results:
+
+- open [http://localhost:3000](http://localhost:3000) for the web app
+
diff --git a/apps/docs/src/content/docs/contributing/requirements.mdx b/apps/docs/src/content/docs/contributing/requirements.mdx
index 75ef9d0bf..d0a15656a 100644
--- a/apps/docs/src/content/docs/contributing/requirements.mdx
+++ b/apps/docs/src/content/docs/contributing/requirements.mdx
@@ -73,3 +73,8 @@ To install brew, it is recommended to use brew.sh from
If you want to run Turso locally you can follow the instructions in the
[Turso CLI](https://docs.turso.tech/reference/turso-cli)
+
+
+### Installing Bun
+
+To install Bun, visit the official website [https://bun.sh/](https://bun.sh/)
\ No newline at end of file
diff --git a/packages/tinybird/src/client.ts b/packages/tinybird/src/client.ts
index 0b9ebf18a..f42ef98b3 100644
--- a/packages/tinybird/src/client.ts
+++ b/packages/tinybird/src/client.ts
@@ -9,11 +9,11 @@ export class OSTinybird {
private readonly tb: Client;
constructor(token: string) {
- // if (process.env.NODE_ENV === "development") {
- // this.tb = new NoopTinybird();
- // } else {
- this.tb = new Client({ token });
- // }
+ if (process.env.NODE_ENV === "development") {
+ this.tb = new NoopTinybird();
+ } else {
+ this.tb = new Client({ token });
+ }
}
public get homeStats() {