{"id":20521537,"url":"https://github.com/iver-wharf/wharf-web","last_synced_at":"2026-04-18T10:38:17.157Z","repository":{"id":40366927,"uuid":"365957731","full_name":"iver-wharf/wharf-web","owner":"iver-wharf","description":"Frontend to Wharf, written in Angular","archived":false,"fork":false,"pushed_at":"2024-03-15T12:51:48.000Z","size":5891,"stargazers_count":2,"open_issues_count":22,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-11T14:47:50.571Z","etag":null,"topics":["angular","primeng","typescript","wharf","wharf-frontend"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iver-wharf.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2021-05-10T07:37:48.000Z","updated_at":"2023-01-30T17:19:27.000Z","dependencies_parsed_at":"2024-11-15T22:30:44.088Z","dependency_job_id":"3705375c-bbdd-4bb2-ac86-eb8df338b11f","html_url":"https://github.com/iver-wharf/wharf-web","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/iver-wharf/wharf-web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iver-wharf","download_url":"https://codeload.github.com/iver-wharf/wharf-web/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iver-wharf%2Fwharf-web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31966207,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","primeng","typescript","wharf","wharf-frontend"],"created_at":"2024-11-15T22:29:42.664Z","updated_at":"2026-04-18T10:38:17.140Z","avatar_url":"https://github.com/iver-wharf.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wharf Angular frontend\n\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/89402a769e2d4b70ba15ff29992ae6ed)](https://www.codacy.com/gh/iver-wharf/wharf-web/dashboard?utm_source=github.com\\\u0026utm_medium=referral\\\u0026utm_content=iver-wharf/wharf-web\\\u0026utm_campaign=Badge_Grade)\n\n![Wharf web screenshot](docs/screenshot.jpg)\n\n## Prerequisites\n\n- **NPM v6.x.x,** which comes with Node.js LTS.\n\n  This is because Angular does not support Node.js Current, and recently they\n  got an incompatability with Node.js v16 / NPM v7.\n\n  Read more about it here:\n  \u003chttps://github.com/angular/angular-cli/issues/19957#issuecomment-775407654\u003e\n\n## Building project\n\nThe project requires api-client library and `import-*` provider libraries to be\nbuilt first.\n\n1. Get dependencies\n\n   ```console\n   $ npm install\n   ```\n\n2. Build API client libraries\n\n   ```console\n   $ npm run build-clients\n   ```\n\n3. Build and start server\n\n   ```console\n   $ npm start\n   ```\n\n## Generate models and services\n\nIn case you need to regenerate the api clients, run the\n`./generate-rest-client.ps1` script in powershell:\n\n- Windows:\n\n  ```powershell\n  PowerShell.exe -ExecutionPolicy Bypass -File ./generate-rest-client.ps1\n  ```\n\n- Linux:\n\n  1. Install PowerShell Core, for example by following a guide from \u003chttps://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-linux\u003e\n     or by installing .NET SDK and installing it via the `dotnet` CLI\n     (installed via \u003chttps://dotnet.microsoft.com/download?initial-os=linux\u003e)\n     by running:\n\n     ```console\n     $ dotnet tool install --global powershell\n     ```\n\n  2. Now you can run the script:\n\n     ```console\n     $ ./generate-rest-client.ps1\n     ```\n\n## Run locally via Docker\n\nUse [GNU Make](https://www.gnu.org/software/make/) or [GNUWin32](http://gnuwin32.sourceforge.net/install.html).\n\n1. Build the docker image:\n\n   ```console\n   $ make docker\n   ```\n\n2. Run the built docker image:\n\n   ```console\n   $ make docker-run\n   ```\n\nVisit \u003chttp://localhost:8080/\u003e\n\n## Releasing\n\nReplace the \"v2.0.0\" in `make docker version=v2.0.0` with the new version. Full\ndocumentation can be found at [Releasing a new version](https://iver-wharf.github.io/#/development/releasing-a-new-version).\n\nBelow are just how to create the Docker images using [GNU Make](https://www.gnu.org/software/make/)\nor [GNUWin32](http://gnuwin32.sourceforge.net/install.html):\n\n```console\n$ make docker version=v2.0.0\n[1/2] STEP 1/13: FROM node:14.17.1-alpine3.11 AS build\nTrying to pull docker.io/library/node:14.17.1-alpine3.11...\nGetting image source signatures\nCopying blob ed2a3f372ee3 skipped: already exists\nCopying blob 5ec9f1d3bd97 skipped: already exists\nCopying blob d222216fa792 skipped: already exists\nCopying blob ddad3d7c1e96 [--------------------------------------] 0.0b / 0.0b\nCopying config 58466d7cb9 done\nWriting manifest to image destination\nStoring signatures\n[1/2] STEP 2/13: WORKDIR /usr/src/app\n...\n\nPush the image by running:\ndocker push quay.io/iver-wharf/wharf-web:latest\ndocker push quay.io/iver-wharf/wharf-web:v2.0.0\n```\n\n## Linting from command-line\n\n```sh\nmake deps\n\nmake lint\n\nmake lint-ng # Only run Angular/TypeScript linting\nmake lint-scss # Only run SCSS linting\nmake lint-md # Only run Markdown linting\n```\n\nSome linting errors have quickfixes, such as \"missing semicolon\" or\n\"invalid indentation\" which can be fixed without messing up the semantics of the\ncode. These can be fixed by running the following:\n\n```sh\nmake lint-fix\n\nmake lint-fix-ng # Only fix Angular/TypeScript lint errors\nmake lint-fix-scss # Only fix SCSS lint errors\nmake lint-fix-md # Only fix Markdown lint errors\n```\n\nA lot of other errors, such as \"member should be camelCased\", is not fixable by\nthis `make lint-fix` command. For those, you'll have to fix them manually.\n\n## Linting from IDE\n\n\u003e First make sure the project builds by following the [#Building project](#building-project)\n\u003e guide above.\n\n### Linting from Visual Studio Code\n\n1. Install extensions\n\n   - ESLint (`dbaeumer.vscode-eslint`): \u003chttps://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint\u003e\n   - vscode-remark-lint (`vscode-remark-lint`): \u003chttps://marketplace.visualstudio.com/items?itemName=drewbourne.vscode-remark-lint\u003e\n   - stylelint (`stylelint.vscode-stylelint`): \u003chttps://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint\u003e\n\n   \u003e :warning: The `vscode-remark-lint` extension has not proven itself to work\n   \u003e previously. If it does not work correctly for you, then skip it and rely\n   \u003e on the command-line linting instead.\n\n2. Install NPM dependencies (required by stylelint):\n\n   ```sh\n   npm install\n   ```\n\n3. Open a `*.ts` file\n\n4. Click the \"🚫 ESLINT\" tab in the bottom right toolbar and then select\n   either \"Enable\" or \"Enable everywhere\"\n\n   ![ESLINT button in toolbar](./docs/linting-in-vscode-enable.png)\n\n5. Done!\n\n   ![ESLINT extension in action inside VS Code](./docs/linting-in-vscode.png)\n\n### Linting from vim/neovim\n\n1. Install plugins:\n\n   - [coc.nvim](https://github.com/neoclide/coc-eslint)\n   - [ALE](https://github.com/dense-analysis/ale)\n\n   \u003e :warning: Warning: coc.nvim is not that well compatible with other\n   \u003e autocompletion plugins, such as YouCompleteMe, deoplete, etc. Use at your\n   \u003e own risk.\n\n2. Configure coc.nvim \u0026 ALE to play well together\n\n   1. Add the following to your vim config (`~/.config/{vim,nvim}/init.vim`)\n\n      ```vim\n      let g:ale_disable_lsp = 1\n      ```\n\n   2. Add this to your coc.nvim config (open it with `:CocConfig`):\n\n      ```json\n      \"diagnostic.displayByAle\": true\n      ```\n\n3. Install coc.nvim extensions\n\n   - [`coc-eslint`](https://github.com/neoclide/coc-eslint)\n   - [`coc-stylelint-plus`](https://github.com/bmatcuk/coc-stylelintplus)\n\n   ```vim\n   :CocInstall coc-eslint\n   :CocInstall coc-stylelintplus\n   ```\n\n4. Install NPM dependencies (required by stylelint):\n\n   ```sh\n   npm install\n   ```\n\n5. Open a `*.ts` file\n\n6. Open the `coc-eslint` output to see the options to enable it\n\n   ```vim\n   :CocCommand eslint.showOutputChannel\n   ```\n\n7. Done!\n\n   ![coc-eslint in action inside neovide](./docs/linting-in-neovide.png)\n\n## Project style guides\n\n- Do not set public members explicitly\n- If you can define as many members as possible as private\n- If possible use interface instead of class for data contract\n\n---\n\nMaintained by [Iver](https://www.iver.com/en).\nLicensed under the [MIT license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiver-wharf%2Fwharf-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiver-wharf%2Fwharf-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiver-wharf%2Fwharf-web/lists"}