{"id":13588681,"url":"https://github.com/f4exb/sdrangelspectrum","last_synced_at":"2025-07-23T13:04:59.854Z","repository":{"id":38550799,"uuid":"262837041","full_name":"f4exb/sdrangelspectrum","owner":"f4exb","description":"Web client for SDRangel websockets spectrum server","archived":false,"fork":false,"pushed_at":"2023-07-14T07:09:52.000Z","size":1277,"stargazers_count":13,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-14T12:52:30.822Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/f4exb.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":"2020-05-10T17:13:34.000Z","updated_at":"2025-04-10T02:31:40.000Z","dependencies_parsed_at":"2025-02-25T09:43:38.703Z","dependency_job_id":null,"html_url":"https://github.com/f4exb/sdrangelspectrum","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/f4exb/sdrangelspectrum","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f4exb%2Fsdrangelspectrum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f4exb%2Fsdrangelspectrum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f4exb%2Fsdrangelspectrum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f4exb%2Fsdrangelspectrum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/f4exb","download_url":"https://codeload.github.com/f4exb/sdrangelspectrum/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/f4exb%2Fsdrangelspectrum/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266682592,"owners_count":23967837,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":[],"created_at":"2024-08-01T15:06:51.729Z","updated_at":"2025-07-23T13:04:59.831Z","avatar_url":"https://github.com/f4exb.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"![SDR Angel Spectrum banner](doc/img/sdrangelspectrum.png)\n\n# Introduction\n\n**\u0026#9888; WARNING: this is a work in progress**\n\nThis is a browser based web client for remote spectrum display provided by [SDRangel SDR software](https://github.com/f4exb/sdrangel) Please click on the link to get more information. It is available only from version v5.6.0 of SDRangel.\n\nYou may also ask questions about SDRangel or this web application in the [SDRangel group](https://groups.io/g/sdrangel) in groups.io\n\nSDRangel is a Software Defined Radio (SDR) application that processes the digital samples produced by various SDR front end devices (RTL-SDR, LimeSDR, ...) using software running on commodity computers to implement radio processing functions that used to be handled by hardware e.g AM, FM demodulation... SDRangel is also capable of driving SDR transmitters in a reversed flow: it produces digital samples that are sent to a SDR transmitter (LimeSDR, HackRF...) to eventually produce a RF signal.\n\nThis web application communicates with a SDRangel running instance (GUI based or headless). Relevant spectrum details are controlled via the REST API of SDRangel and the spectrum display uses a secondary websockets based server on a different port. It is written based on Angular 15 (see development section for more details).\n\n# Prerequisites\n\n## Step 1. Node \u0026 Git\n\n* Make sure you have [Git](https://www.git-scm.com) installed\n* Make sure you have [NodeJS 12](https://nodejs.org/) or later installed on your machine\n* Make sure you have npm (Node Package Manager, comes bundled with NodeJS) at least version 6\n\nYou can check whether you already have them and your current versions by executing\n\n```bash\ngit --version\nnode --version\nnpm --version\n```\n\n### Install node JS and NPM:\n\n#### Arch:\n```bash\nsudo pacman -S nodejs npm\n```\n\n#### Debian/Raspbian/Ubuntu:\n```bash\nsudo apt-get install nodejs npm\n```\n\n#### OpenSUSE:\n```bash\nsudo zypper in nodejs npm\n```\n\n### If you need to use multiple node versions on your machine consider using:\n\n* [nvm](https://github.com/creationix/nvm) (OSX, Linux)\n* [nodist](https://github.com/marcelklehr/nodist) (Win)\n* [nvm-windows](https://github.com/coreybutler/nvm-windows) (Win)\n\n### You might want update the `npm` to the latest version by doing:\n\n```bash\nsudo npm install npm -g\n```\n\n### And for node do:\n\n```bash\nsudo npm cache clean -f\nsudo npm install -g n\nsudo n stable\n```\n\n## Step 2. Clone the repository and set up environment\n\n```bash\n# clone → it will create the directory named 'sdrangelspectrum' in the current one\ngit clone https://github.com/f4exb/sdrangelspectrum\n\n# install global dependencies\nsudo npm install -g @angular/cli@15\n\n# install local dependencies\ncd sdrangelspectrum\nnpm install\n\n# check that everything is working by running the following and opening http://localhost:4200 in your browser afterwards\nnpm start\n```\nBe patient `npm install` can be very long depending on your hardware.\n\n# Build and serve\n\n## Build\n\n```bash\n# build\ncd sdrangelspectrum\nng build --configuration production # use --configuration production for production build\n\n# This will create a dist/sdrangelspectrum directory that will contain the application\n# You can copy or move sdrangelspectrum directory wherever you like\n\n```\n\n## Serve directly\n\n```bash\n# Install a simple node.js server\nsudo npm install http-server -g\n\n# in the dist/sdrangelspectrum directory do\nhttp-server\n\n# By default http-server listens on all available network interfaces on port 8080.\n# This can be changed with the options:\n#   -p \u003cport\u003e\n#   -a \u003caddress\u003e This is the address of the network interface on the server\n\n```\n\n## Serve with supervisord\n\nWe will not cover supervisord setup and jump into the creation of a `.conf` file for `sdrangelspectrum`.\n\nAssumptions:\n  - the distribution is installed in `/opt/build/sdrangelspectrum/dist/sdrangelspectrum`\n  - the network interface address is `192.168.2.1` and port `8001` will be used\n  - the user name is `f4exb`\n\nYou may adapt it to your own needs.\n\nCreate a `/etc/supervisor.d/sdrangelspectrum.conf` with this content:\n\n```bash\n[program:sdrangelspectrum]\ndirectory = /opt/build/sdrangelspectrum/dist/sdrangelspectrum\ncommand = http-server -a 192.168.2.1 -p 8001\nprocess_name = sdrangelspectrum\nuser = f4exb\nstopsignal = INT\nautostart = false\nautorestart = false\nenvironment =\n    USER=f4exb,\n    PATH=\"/usr/local/sbin:/usr/local/bin:/usr/bin:/usr/bin/site_perl:/usr/bin/vendor_perl:/usr/bin/core_perl\",\n    HOME=\"/home/f4exb\"\nredirect_stderr = true\nstdout_logfile = /home/f4exb/log/sdrangelspectrum.log\nstdout_logfile_maxbytes = 10MB\nstdout_logfile_backups = 3\nloglevel = debug\n```\n\nIn `/etc/supervisord.conf` add `/etc/supervisor.d/sdrangelspectrum.conf` to the list of processes controlled by `supervisord`:\n\n```bash\n...\n[include]\nfiles = /etc/supervisor.d/sdrangelsrv.conf /etc/supervisor.d/sdrangelspectrum.conf\n```\n\nReload supervisord configuration with `sudo systemctl reload supervisord`\n\n# Development\n\n## Prerequisites\n\n### Step 1. Configure your IDE\n\nWe'll be wring code using TypeScript and Angular, so it would be nice to have at least code highlighting and autocompletion.\nWe recommend using:\n\n* [Visual Studio Code (free)](https://code.visualstudio.com/Download) - After the installation, run the IDE and make sure the recommended extensions are installed as described in this [guide](https://code.visualstudio.com/docs/editor/extension-gallery#_workspace-recommended-extensions). All extensions are listed under `.vscode/extension.json` and can be viewed in the UI using \"Show workspace recommended extensions\" filter.\n\n### Step 2. Install Angular Augury plugin\n\nIf you're using Chrome it might be a good idea to install the [Augury Plugin](https://augury.angular.io) that will help debugging Angular applications\n\n## Sdrangelspectrum\n\nThis project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.\n\n### Development server\n\nRun `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.\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 `dist/` directory. Use the `--prod` flag for a production build.\n\n### Running unit tests\n\nWARNING: not supported\n\nRun `ng test` or `npm test` to execute the unit tests via [Karma](https://karma-runner.github.io). This is good for TDD as the tests run continuously whenever the code changes on disk.\n\n### Running end-to-end tests\n\nWARNING: not supported\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff4exb%2Fsdrangelspectrum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ff4exb%2Fsdrangelspectrum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ff4exb%2Fsdrangelspectrum/lists"}