{"id":19741804,"url":"https://github.com/ludevnet/lu-explorer","last_synced_at":"2025-07-01T14:06:03.484Z","repository":{"id":39555272,"uuid":"124371418","full_name":"LUDevNet/lu-explorer","owner":"LUDevNet","description":"An angular.io webapp that displays LEGO Universe game data","archived":false,"fork":false,"pushed_at":"2024-10-10T17:15:05.000Z","size":4486,"stargazers_count":13,"open_issues_count":31,"forks_count":5,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-08T10:46:53.451Z","etag":null,"topics":["angular","angular-cli","lego-universe","webapp"],"latest_commit_sha":null,"homepage":"https://lu-dev.net/lu-explorer/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LUDevNet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-08T09:51:21.000Z","updated_at":"2024-12-14T15:11:23.000Z","dependencies_parsed_at":"2024-05-10T21:32:22.188Z","dependency_job_id":"f056f682-f0cb-4d9b-8de0-108c1a798572","html_url":"https://github.com/LUDevNet/lu-explorer","commit_stats":null,"previous_names":["xiphoseer/lu-explorer"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/LUDevNet/lu-explorer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LUDevNet%2Flu-explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LUDevNet%2Flu-explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LUDevNet%2Flu-explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LUDevNet%2Flu-explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LUDevNet","download_url":"https://codeload.github.com/LUDevNet/lu-explorer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LUDevNet%2Flu-explorer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262978551,"owners_count":23394008,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular-cli","lego-universe","webapp"],"created_at":"2024-11-12T01:27:55.546Z","updated_at":"2025-07-01T14:06:03.458Z","avatar_url":"https://github.com/LUDevNet.png","language":"TypeScript","readme":"# LuExplorer\n\n## General\n\nThis project was generated with [Angular CLI](https://github.com/angular/angular-cli).\n\n## Prerequisites\n\n- [`git`](https://git-scm.com/)\n- [`npm`](https://npmjs.com) to build the app\n- [`cargo`](https://doc.rust-lang.org/cargo/) to build the API server\n- A copy of a LEGO Universe client.\n\n## Development setup\n\nGenerally, LU-Explorer needs a datasource, which is provided by the [Paradox Server](https://github.com/xiphoseer/lu-res-api-server). That server provides the data from the game database to the web interface, which makes it a core\ncomponent of this app.\n\nThis needs a `paradox.toml` config file in the working directory – a minimal example is provided [here](https://github.com/Xiphoseer/lu-explorer/blob/main/paradox.toml). The most important part is to point the `explorer_spa` key to the `docs` folder in this repo and the `cdclient` and `locale` key to a copy of `CDClient.fdb` and `locale.xml` respectively.\n\n1. install `npm` and `cargo` (via \u003chttps://rustup.rs\u003e)\n2. install the API server binary with\n\n   ```shell\n   $ cargo install --git https://github.com/Xiphoseer/lu-res-api-server.git --branch main\n   ```\n3. Then, clone this repo and create `lu-res` and `client` folders next to it\n\n   ```shell\n   $ git clone https://github.com/Xiphoseer/lu-explorer.git\n   $ mkdir lu-res client\n   ```\n4. Put at least `locale/locale.xml` and `res/cdclient.fdb` from an LU client into this `client` folder\n5. You can now build the `lu-explorer` web-app continuously with\n   ```shell\n   $ cd lu-explorer\n   $ npm install\n   $ ng build --watch\n   ```\n6. Finally, run the API server, which will also serve the web-app\n   ```shell\n   $ RUST_LOG=info paradox-server\n   ```\n\nFor now, you need to restart that server whenever you change the `lu-explorer` source.\n([Issue #1](https://github.com/Xiphoseer/lu-res-api-server/issues/1))\n\n## Minimal setup\n\nThe alternative is to:\n\n1. point `data.apiUrl` in `src/environments/environment.ts` to an existing API server.\n2. point `/lu-res` in `src/proxy.conf.json` to a matching version of `lu-res`.\n\nThen run\n\n```shell\n$ npm install\n$ ng serve\n```\n\n## Docker Setup\n\n\n1. Build:\n  `docker build -t paradox-server`\n2. Deploy:\n\nReplace the paths on the left of the mappings to reflect your system:\n```docker\n  docker run -it --rm \\\n    --name paradox-server \\\n    -e DOMAIN=your.domain.tld \\\n    -e USERNAME=\u003cusername\u003e \\\n    -e PASSWORD=\u003cpassword\u003e \\\n    -v /path/to/client:/luclient \\\n    -v /path/to/cache:/cache/lu-res \\\n    -p 3030:3030 \\\n    paradox-server\n```\n\n## Code scaffolding\n\nRun `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.\n\n## Build\n\nRun `ng build` to build the project. The build artifacts will be stored in the `docs/` directory. Use the `--configuration production` flag for a production build. For building to github pages also use `--base-href=/lu-explorer/`.\n\nUsually, the `ng build --configuration production` command is used.\n\n## Running unit tests\n\nRun `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).\n\n## Running end-to-end tests\n\nRun `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).\n\n## Further help\n\nTo get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fludevnet%2Flu-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fludevnet%2Flu-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fludevnet%2Flu-explorer/lists"}