-
Notifications
You must be signed in to change notification settings - Fork 126
The ADS‐B Portal Frontend
The ADS-B Portal Frontend is currently in development.
Those wishing to develop their own application capable of consuming data provided by the ADS-B Portal API, there is an OpenAPI v3.1.0 Specification for the API available. This file will allow you to easily generate an SDK capable of communicating with API using a multitude of different languages from which you may choose from to develop your own application. The latest version of the specification is located here. More information on the ADS-B Portal API can be found in the ADS-B Portal API wiki page. Keep in mind that at this time content contained within this page is evolving quickly as development on the API progresses.
The ADS-B Portal is an Angular application meant to display data as well as allow administrators to manage the portal by interfacing with the ADS-B Portal API.
The ADS-B Portal is being developed as a separate application from the ADS-B Portal API. This means the portal is able to run on different hardware than that on which the API application resides if one so wishes. This gives users the ability to relocate the portal as long as the ADS-B Portal API endpoints are accessible to the Internet or the private network on which the portal resides.
You can track development progress in the portal branch located in this repository. There is currently no automated installation script available for the portal. In order to test the portal, you will either need to set it up manually or run it in your favorite IDE along with an instance of the ADS-B Portal API.
The portal can be developed and debugged in your favorite IDE as long as it supports Angular development and has access to a running copy of the ADS-B Portal API. The following are instruction on how to set up the project in Visual Studio Code. Information on setting up a development environment on additional IDEs may be made available over time.
Clone the repository and checkout the portal branch.
git clone https://github.com/jprochazka/adsb-receiver`
git checkout portal
Visual Studio Code can be downloaded free from here.
First install Node.js for the platform on which you are developing. While installing Node.js make sure to install npm as well. By default, npm is installed by the Node.js installer unless the option is unselected. Once installed check that Node.js and npm are installed and utilizing the proper version by running the following commands.
node --version
npm --version
Open Visual Studio Code and open the folder containing the frontend code.
~/adsb-receiver/build/portal/frontend
To install the Angular Language Service which offers a better Angular editing experience visit the Angular Language Service Extension Page on the Visual Studio Marketplace and click the install button.
Once you are ready to install the Angular CLI, open a Visual Studio Code open a terminal and execute the following command in order to install it.
npm install -g @angular/cli
After the Angular CLI is installed run the following command to install the packages currently utilized by the application.
npm install
You should now be able to run the application by executing the command ng serve then opening a web browser pointed to http://localhost:4200.
The files needed to debug the application using Visual Studio Code are include in the repository. You may wish to modify ~/.vscode/launch.json and change the lines which look like "type": "chrome", to something like such as msedge if you wish to use a browser other than chrome when debugging the application.
To start debugging the application press F5 which will build the application and launch Node.js before opening the specified browser which will load the page located at http://localhost:4200.
To stop debugging press Ctrl+C in the terminal.