This document provides an overview of the tools and packages needed to work on and to build aether-roc-gui. Developers are expected to have these tools installed on the machine where the project is built.
For non developers - the image is auto published as a Docker image here.
If you already have the classic ONOS project code checked out and built using Bazel
on your system, then you already have all the tools you need.
Add the following 2 entries to your $PATH environment variable to give access
to the npm and the ng command respectively
[bazel output_base]/external/nodejs_linux_amd64/bin/nodejs/bin~/onos/web/gui2/node_modules/@angular/cli/bin
where [bazel output_base] above can be found from running the command:
bazel info output_baseAfter setting the PATH it should be possible to see the version of node and npm:
node -v
npm -v
which ngIf legacy ONOS is not available install the latest Long Term Support version of NodeJS on your system.
- Downloads are available from https://nodejs.org/en/download/
- Please use v10.16.0 or greater
- Instructions for installing on Linux are at https://github.com/nodejs/help/wiki/Installation
After installing it should be possible to see the version of node and npm (which is bundled with it) that you installed with:
node -v
npm -vIf legacy ONOS is not available install Angular CLI to provide the ng tools. Installation instructions are at https://angular.io/guide/setup-local
The following command can be run from any folder:
npm install -g @angular/cliUsing a process described contributing.md the Git repo should be forked in your own name on github.com/onosproject/aether-roc-gui.
git clone [email protected]:$GIT_USER/aether-roc-gui.gitcd $ONOS_ROOT/aether-roc-gui
git remote add upstream [email protected]:onosproject/aether-roc-gui.git
# Never push to upstream master
git remote set-url --push upstream no_push
# Confirm that your remotes make sense:
git remote -vAfter this install it should be possible to see the Angular CLI version:
ng versionThis should give a result like:
_ _ ____ _ ___
/ \ _ __ __ _ _ _| | __ _ _ __ / ___| | |_ _|
/ △ \ | '_ \ / _` | | | | |/ _` | '__| | | | | | |
/ ___ \| | | | (_| | |_| | | (_| | | | |___| |___ | |
/_/ \_\_| |_|\__, |\__,_|_|\__,_|_| \____|_____|___|
|___/
Angular CLI: 10.1.2
Node: 10.16.0
OS: linux x64
Angular: 10.1.2
... animations, cli, common, compiler, compiler-cli, core, forms
... platform-browser, platform-browser-dynamic, router
Ivy Workspace: Yes
Package Version
---------------------------------------------------------
@angular-devkit/architect 0.1001.2
@angular-devkit/build-angular 0.1001.2
@angular-devkit/core 10.1.2
@angular-devkit/schematics 10.1.2
@angular/cdk 10.2.2
@angular/material 10.2.2
@schematics/angular 10.1.2
@schematics/update 0.1001.2
rxjs 6.6.3
typescript 4.0.2The Angular dependencies must be installed. This is as simple as running npm install
in the folder. This takes the dependencies listed in package.json and installs
them in the temporary folder node_modules:
npm installDocker is required to build the project Docker images.
Some form of local kubernetes development environment is also needed. The core team uses Kind, but there are other options such as Minikube and Microk8s for Ubuntu. deploy gives more details on a Helm installation.
Some form of an integrated development environment that supports Web Development with TypeScript is also recommended. The core team uses the Intellij WebStorm IDE from JetBrains, but there are many other options. The Atom editor is a lightweight solution supporting TypeScript and Git integration. Visual Studio Code is another option that supports TypeScript.
The project requires that all Typescript source files are properly annotated using the Member Only License. Since this requirement is enforced by the CI process, it is strongly recommended that developers setup their IDE to include the license text automatically.