Openstatus
www.openstatus.dev
[Docs] Improve setup documentation DX (#355)
* add-default-showcopy-code
Signed-off-by: Gaurav Chadha <gauravchadha1676@gmail.com>
* add-setupenv-imgages
Signed-off-by: Gaurav Chadha <gauravchadha1676@gmail.com>
* dynamic-footer
Signed-off-by: Gaurav Chadha <gauravchadha1676@gmail.com>
* improve-setup-docs-dx
Signed-off-by: Gaurav Chadha <gauravchadha1676@gmail.com>
* fix-typo
Signed-off-by: Gaurav Chadha <gauravchadha1676@gmail.com>
* update-lock-file
Signed-off-by: Gaurav Chadha <gauravchadha1676@gmail.com>
---------
Signed-off-by: Gaurav Chadha <gauravchadha1676@gmail.com>
authored by
Gaurav Chadha
and committed by
GitHub
7140e852
509cba36
+55
-17
+1
apps/docs/next.config.mjs
+1
apps/docs/next.config.mjs
+1
apps/docs/package.json
+1
apps/docs/package.json
+18
-3
apps/docs/pages/developer-guide/get-started.mdx
+18
-3
apps/docs/pages/developer-guide/get-started.mdx
···
1
1
## Setup
2
2
3
-
1. Clone the repository
3
+
1. Clone the repository and open the created directory
4
4
5
5
```sh
6
6
git clone https://github.com/openstatushq/openstatus.git
7
+
cd openstatus
7
8
```
8
9
9
10
2. Install dependencies
···
43
44
44
45
5. Set up your .env file
45
46
46
-
from `apps/web` and `packages/db` you will find .env.example create your own.
47
+
from `apps/web` and `packages/db` you will find .env.example. Please create your own.
48
+
49
+
6. Start the web app locally
47
50
48
-
6. Clerk Authentication
51
+
```sh
52
+
pnpm dev
53
+
```
54
+
> 💡 If you are getting this error - ` ERROR run failed: error preparing engine: Invalid persistent task configuration:
55
+
You have 15 persistent tasks but `turbo` is configured for concurrency of 10. Set --concurrency to at least 16
56
+
`
57
+
Then `cd` into web directory and then start the web app
58
+
> ```sh
59
+
> cd apps/web
60
+
> pnpm dev
61
+
> ```
62
+
63
+
7. Clerk Authentication
49
64
50
65
For authentication we are using [Clerk](https://clerk.dev/), you will need to
51
66
create an account and get your API keys. If you want to work on the backend and
+8
-5
apps/docs/pages/developer-guide/requirements.mdx
+8
-5
apps/docs/pages/developer-guide/requirements.mdx
···
1
-
To begin with, you need to consider the following prerequisites with minimum
2
-
versions of certain applications (in addition to Node.js and pnpm which were
3
-
already mentioned earlier):
1
+
## System Requirements
4
2
5
-
- Node.js >= 18.0.0
6
-
- pnpm >= 8.6.2
3
+
Before you start, make sure you have the following applications and their minimum versions installed,
4
+
in addition to Node.js and pnpm (as mentioned earlier):
5
+
6
+
- [Node.js 18.0.0](https://nodejs.org/) or later.
7
+
- [pnpm 8.6.2](https://nodejs.org/) or later.
8
+
- macOS, Windows (including WSL), and Linux are supported.
7
9
8
10
## Installing Node.js
9
11
···
67
69
brew install sqld-beta
68
70
sqld --help
69
71
```
72
+
> *Note: Please ensure to add sqld to you system PATH*
70
73
71
74
This will allow you to work with the local database without modifying the ".env"
72
75
file.
+9
-3
apps/docs/pages/developer-guide/setup-env.mdx
+9
-3
apps/docs/pages/developer-guide/setup-env.mdx
···
30
30
6. Paste these values into the `.env` file under their respective variables. It
31
31
should look something like this (real values without censorship):
32
32
33
+
34
+
33
35
```
34
36
# CLERK for auth
35
37
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_••••••••••••••••••••••••••••••••••••••••••
···
63
65
5. Paste this API Key value into the `.env` file under the "RESEND_API_KEY"
64
66
variable. It should look something like this (real values without
65
67
censorship):
68
+
69
+
66
70
67
71
```
68
72
# RESEND for email
···
141
145
142
146
## Setting up Tinybird
143
147
144
-
You will need to create an API token under Auth tokens > Workspace tokens > Add
145
-
a new token.
148
+
You will need to create an API token, Go to Auth tokens > Workspace tokens > Add
149
+
a new token > Select your token
150
+
151
+
146
152
147
153
```
148
154
# TinyBird
···
255
261
configurations.
256
262
257
263
258
-
## **Setting up tinybird**
264
+
## **Connect datasource using tinybird-cli**
259
265
260
266
1. Log in to your tinybird account at https://www.tinybird.co/ or create a new account if you don't have one yet.
261
267
+1
-1
apps/docs/pages/developer-guide/setup.mdx
+1
-1
apps/docs/pages/developer-guide/setup.mdx
···
52
52
file. These variables may include configurations related to the database, API
53
53
credentials, etc.
54
54
55
-
Keep in mind that the `.env` file should be kept private and should not be
55
+
⚠️ Keep in mind that the `.env` file should be kept **private** and should not be
56
56
shared publicly as it may contain sensitive information such as passwords or
57
57
access keys.
58
58
apps/docs/public/img/setup-env/clerk.png
apps/docs/public/img/setup-env/clerk.png
This is a binary file and will not be displayed.
apps/docs/public/img/setup-env/resend.png
apps/docs/public/img/setup-env/resend.png
This is a binary file and will not be displayed.
apps/docs/public/img/setup-env/tinybird.png
apps/docs/public/img/setup-env/tinybird.png
This is a binary file and will not be displayed.
+9
-1
apps/docs/theme.config.tsx
+9
-1
apps/docs/theme.config.tsx
···
11
11
docsRepositoryBase:
12
12
"https://github.com/openstatusHQ/openstatus/tree/main/apps/docs",
13
13
footer: {
14
-
text: "OpenStatus Documentation",
14
+
text: (
15
+
<span>
16
+
Copyright {new Date().getFullYear()} ©{' '}
17
+
<a href="https://www.openstatus.dev/" target="_blank">
18
+
OpenStatus
19
+
</a>
20
+
.
21
+
</span>
22
+
)
15
23
},
16
24
head: (
17
25
<>
+8
-4
pnpm-lock.yaml
+8
-4
pnpm-lock.yaml
···
58
58
version: 18.2.0(react@18.2.0)
59
59
swagger-ui-react:
60
60
specifier: 5.9.0
61
-
version: 5.9.0(react-dom@18.2.0)(react@18.2.0)
61
+
version: 5.9.0(@types/react@18.2.12)(react-dom@18.2.0)(react@18.2.0)
62
62
devDependencies:
63
63
'@openstatus/tsconfig':
64
64
specifier: workspace:*
···
66
66
'@types/node':
67
67
specifier: 18.11.10
68
68
version: 18.11.10
69
+
'@types/react':
70
+
specifier: 18.2.12
71
+
version: 18.2.12
69
72
'@types/swagger-ui-react':
70
73
specifier: 4.18.1
71
74
version: 4.18.1
···
12475
12478
resolution: {integrity: sha512-kzmNjIgU32mO4mmH5+iUyrqlpFQhF8K2k7eZ4fdLSOPFrD1XgEuSBv9LDEgxRXTMBqMd8ppT0x6TIzqE5pdGdw==}
12476
12479
dev: false
12477
12480
12478
-
/react-redux@8.1.2(react-dom@18.2.0)(react@18.2.0)(redux@4.2.1):
12481
+
/react-redux@8.1.2(@types/react@18.2.12)(react-dom@18.2.0)(react@18.2.0)(redux@4.2.1):
12479
12482
resolution: {integrity: sha512-xJKYI189VwfsFc4CJvHqHlDrzyFTY/3vZACbE+rr/zQ34Xx1wQfB4OTOSeOSNrF6BDVe8OOdxIrAnMGXA3ggfw==}
12480
12483
peerDependencies:
12481
12484
'@types/react': ^16.8 || ^17.0 || ^18.0
···
12498
12501
dependencies:
12499
12502
'@babel/runtime': 7.22.15
12500
12503
'@types/hoist-non-react-statics': 3.3.2
12504
+
'@types/react': 18.2.12
12501
12505
'@types/use-sync-external-store': 0.0.3
12502
12506
hoist-non-react-statics: 3.3.2
12503
12507
react: 18.2.0
···
13615
13619
- debug
13616
13620
dev: false
13617
13621
13618
-
/swagger-ui-react@5.9.0(react-dom@18.2.0)(react@18.2.0):
13622
+
/swagger-ui-react@5.9.0(@types/react@18.2.12)(react-dom@18.2.0)(react@18.2.0):
13619
13623
resolution: {integrity: sha512-j45ceuGHMRmI8nhOaG71VeQwrPutFHDq6QhgrxOmf4BRMOdOQgVY1POQY9ksnXZtskbD9J2NHURs4BLEDIs8gA==}
13620
13624
peerDependencies:
13621
13625
react: '>=17.0.0'
···
13644
13648
react-immutable-proptypes: 2.2.0(immutable@3.8.2)
13645
13649
react-immutable-pure-component: 2.2.2(immutable@3.8.2)(react-dom@18.2.0)(react@18.2.0)
13646
13650
react-inspector: 6.0.2(react@18.2.0)
13647
-
react-redux: 8.1.2(react-dom@18.2.0)(react@18.2.0)(redux@4.2.1)
13651
+
react-redux: 8.1.2(@types/react@18.2.12)(react-dom@18.2.0)(react@18.2.0)(redux@4.2.1)
13648
13652
react-syntax-highlighter: 15.5.0(react@18.2.0)
13649
13653
redux: 4.2.1
13650
13654
redux-immutable: 4.0.0(immutable@3.8.2)