https://github.com/jpsingleton/huxley2
A cross-platform JSON proxy for the GB railway Live Departure Boards SOAP API
https://github.com/jpsingleton/huxley2
api aspnet-core aspnetcore c-sharp c-sharp-10 c-sharp-8 c-sharp-9 csharp dotnet dotnet-6 dotnet-core dotnet6 dotnetcore json soap
Last synced: about 1 year ago
JSON representation
A cross-platform JSON proxy for the GB railway Live Departure Boards SOAP API
- Host: GitHub
- URL: https://github.com/jpsingleton/huxley2
- Owner: jpsingleton
- License: eupl-1.2
- Created: 2020-04-15T16:32:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-21T14:21:09.000Z (over 1 year ago)
- Last Synced: 2025-05-19T10:19:39.511Z (about 1 year ago)
- Topics: api, aspnet-core, aspnetcore, c-sharp, c-sharp-10, c-sharp-8, c-sharp-9, csharp, dotnet, dotnet-6, dotnet-core, dotnet6, dotnetcore, json, soap
- Language: C#
- Homepage: https://huxley2.azurewebsites.net
- Size: 255 KB
- Stars: 54
- Watchers: 3
- Forks: 78
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Huxley 2 Community Edition
A cross-platform JSON proxy for the GB railway Live Departure Boards SOAP API
This project is treeware! If you found it useful then please [plant a tree for me](https://ecologi.com/unitsetsoftware).
[](https://ecologi.com/unitsetsoftware)
_Note:_ Huxley 2 is considered feature-complete and will only be updated to fix bugs or move to a new .NET LTS version.
## About
Huxley 2 is a CORS enabled cross-platform JSON ReST proxy for the GB NRE LDB WCF SOAP XML API (called Darwin). It supports both the Public Version (PV) and the Staff Version (SV). It's built with ASP.NET Core LTS (.NET 8.0), C# 10 and lots of abbreviations!
The primary purpose of Huxley 2 is to allow easy use of the LDB API from browser-based client-side PWAs made with JavaScript or TypeScript. Additionally, it opens up the Windows enterprise API to agile developers on macOS and Linux.
## Get Started
Check out [the live demo server](https://huxley2.azurewebsites.net/) for API documentation and to give it a try.
The demo server comes with zero guarantees of uptime.
It can (and regularly does) go down or break.
## Get Your Own
There are detailed instructions on how to host your own instance on Azure in [this blog post](https://unop.uk/huxley-2-release/).
### Running with Docker
1. Ensure you have Docker and Docker Compose installed
2. Create an `.env` file in the `Huxley2` directory with the access tokens. You can delete the ones you're not using.
3. Run `docker-compose up`
4. The app should be available at `localhost:8081`
Example `.env` file:
```env
ACCESS_TOKEN=abcde12345
STAFF_ACCESS_TOKEN=abcde12345
CLIENT_ACCESS_TOKEN=abcde12345
```
To rebuild use `docker-compose build` or `docker-compose up --build`.
If you want to run the container in the background you can run `docker-compose up --detach`
If you would like the docker container to _reboot upon restart_ on the host machine you can uncomment `restart: always` in the docker-compose.yml file and make sure the docker service is set to start upon bootup.
## Station Codes File
If you need to regenerate [the station codes CSV file in this repo](https://raw.githubusercontent.com/jpsingleton/Huxley2/master/station_codes.csv) then you can do so easily with [`jq`](https://stedolan.github.io/jq/) (and `curl`) using an instance that has access to the staff API (and has been restarted recently). On Linux, you can install simply with your package manager, e.g. `sudo apt install jq` (on Ubuntu/Debian).
For example, using the Huxley 2 demo instance you can run this one-liner:
```bash
curl --silent https://huxley2.azurewebsites.net/crs | jq -r '(.[0] | keys_unsorted) as $keys | $keys, map([.[ $keys[] ]])[] | @csv' > station_codes.csv
```
If using a local server with a self-signed certificate:
```bash
curl --silent --insecure https://localhost:5001/crs | jq -r '(.[0] | keys_unsorted) as $keys | $keys, map([.[ $keys[] ]])[] | @csv' > station_codes.csv
```
If you regenerated the station codes CSV file on your own instance, change `StationCodesCsvUrl` in `Huxley2/appsettings.json` to the location of your CSV file.
## License
Licensed under the [EUPL-1.2-or-later](https://joinup.ec.europa.eu/collection/eupl/introduction-eupl-licence).
The EUPL covers distribution through a network or SaaS (like a compatible and interoperable AGPL).