Skip to content

Commit c7d9c01

Browse files
docs: add Codespaces run instructions to PR template
Signed-off-by: Harsh Sachdeva <sachdevaharsh2003@gmail.com>
1 parent 31da449 commit c7d9c01

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

.github/pull_request_template.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,40 @@ Please check the type of change your pull request introduces. Remove all that is
2828
- [ ] Did you provide a general summary of your changes ?
2929
- [ ] Try to limit your pull request to one type, submit multiple pull requests if needed
3030
- [ ] I implemented tests that cover my contribution
31+
32+
33+
<details>
34+
<summary>How to see this running using GitHub Codespaces</summary>
35+
36+
### 1. Open the Codespace
37+
- Authenticate to GitHub
38+
- Go to the branch: [chore/reduce-configure-check-time](https://github.com/LibreSign/libresign/tree/chore/reduce-configure-check-time)
39+
- Click the `Code` button and select the `Codespaces` tab.
40+
- Click **"Create codespace on feat/customize-signature-stamp"**
41+
42+
### 2. Wait for the environment to start
43+
- A progress bar will appear on the left.
44+
- After that, the terminal will show the build process.
45+
- Wait until you see the message:
46+
```bash
47+
✍️ LibreSign is up!
48+
```
49+
This may take a few minutes.
50+
51+
### 3. Access LibreSign in the browser
52+
- Open the **Ports** tab (next to the **Terminal**).
53+
- Look for the service running on port **80**.
54+
- Hover over the URL and click the **globe icon** 🌐 to open it in your browser.
55+
56+
### 4. (Optional) Make the service public
57+
- If you want to share the app with people **not logged in to GitHub**, you must change the port visibility:
58+
- Click the three dots `` on the row for port 80.
59+
- Select `Change visibility``Public`.
60+
61+
### 5. Login credentials
62+
- **Username**: `admin`
63+
- **Password**: `admin`
64+
65+
Done! 🎉
66+
You're now ready to test this.
67+
<details>

0 commit comments

Comments
 (0)