Skip to content

Commit 7276957

Browse files
authored
Merge pull request #5361 from LibreSign/backport/5358/stable31
[stable31] Docs/add GitHub codespaces steps to pr template
2 parents add02f0 + 4e702bb commit 7276957

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

.github/pull_request_template.md

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

0 commit comments

Comments
 (0)