Skip to content

Commit 31ec5e9

Browse files
committed
Merge commit '6733040ce7f5d3297ec02cca567d64cef9d80fd3'
2 parents 2f07da1 + 6733040 commit 31ec5e9

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OSD status dashboard _(wp2.2_dev)_
22

3-
[![Demo backend API](https://img.shields.io/badge/Demo-CLICK%20HERE-red.svg?style=flat)](https://wp22dev.herokuapp.com/)
3+
[![Demo backend API](https://img.shields.io/badge/Demo-CLICK%20HERE-red.svg?style=flat)](https://wp22dev.fly.dev/)
44
[![Python version](https://img.shields.io/badge/Python-3.10-blue.svg?style=flat&logo=Python&logoColor=white)](https://docs.python.org/3.8/)
55
![CodeQL](https://github.com/OPEN-NEXT/wp2.2_dev/workflows/CodeQL/badge.svg)
66
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat)](https://github.com/RichardLitt/standard-readme)
@@ -81,7 +81,7 @@ A [GitHub personal access token](https://docs.github.com/en/github/authenticatin
8181

8282
### Running from source
8383

84-
The code can be run from source and has been tested on updated versions of GNU/Linux server operating systems including [Red Hat Enterprise Linux](https://redhat.com/en/technologies/linux-platforms/enterprise-linux) 8.5. While effort has been made to keep the Python scripts platform-agnostic, they have not been tested under other operating systems such as [BSD](https://en.wikipedia.org/wiki/Berkeley_Software_Distribution)-derivatives, [Apple macOS](https://www.apple.com/macos/) or [Microsoft Windows](https://www.microsoft.com/windows/) as they - especially the latter two- are rarely used for hosting code such as this.
84+
The code can be run from source and has been tested on updated versions of GNU/Linux server operating systems including [Red Hat Enterprise Linux](https://redhat.com/en/technologies/linux-platforms/enterprise-linux) 8.7. While effort has been made to keep the Python scripts platform-agnostic, they have not been tested under other operating systems such as [BSD](https://en.wikipedia.org/wiki/Berkeley_Software_Distribution)-derivatives, [Apple macOS](https://www.apple.com/macos/) or [Microsoft Windows](https://www.microsoft.com/windows/) as they - especially the latter two - are rarely used for hosting code such as this.
8585

8686
On your server, with the tools [`git`](https://git-scm.com/) and [`pip`](https://pip.pypa.io/) installed, run the following commands in a terminal session to retrieve the latest version of this repository and prepare it for development and running locally (usually for testing):
8787

@@ -154,14 +154,6 @@ podman push wp22dev registry.heroku.com/[your app name]/web
154154
heroku container:release web --app=[your app name]
155155
```
156156

157-
A demo of this is hosted on Heroku with this API endpoint:
158-
159-
```
160-
https://wp22dev.herokuapp.com/data
161-
```
162-
163-
This demo instance will go into a sleep state after a period of inactivity (approximately 30 minutes at time of writing). If your API calls to this endpoint is taking more than a few seconds, it might be the demo waking from that state.
164-
165157
#### Fly.io example
166158

167159
Similar to Heroku, the container image created above can be deployed to an app on [Fly.io](https://fly.io/). Assuming a Fly.io account has already been created:
@@ -204,6 +196,14 @@ flyctl secrets set GITHUB_TOKEN=[token]
204196

205197
Where `token` is the 40 character alphanumeric string of your GitHub API personal access token. It is in the form of "ghp_2D5TYFikFsQ4U9KPfzHyvigMycePCPqkPgWc".
206198

199+
A demo of this is hosted on Fly.io with this API endpoint:
200+
201+
```
202+
https://wp22dev.fly.dev/data
203+
```
204+
205+
This demo instance will go into a sleep state after a period of inactivity (approximately 30 minutes at time of writing). If your API calls to this endpoint is taking more than a few seconds, it might be the demo waking from that state.
206+
207207
## Usage
208208

209209
The backend server listens to requests for information about a list of open source hardware (and software) repositories hosted on Wikifactory or GitHub.

0 commit comments

Comments
 (0)