Traffic Portal¶
Introduction¶
Traffic Portal is an AngularJS 1.x client served from a Node.js web server designed to consume the Traffic Ops 1.x API. The Traffic Portal replaces the Traffic Ops UI.
Software Requirements¶
To work on Traffic Portal you need a *nix (MacOS and Linux are most commonly used) environment that has the following installed:
- Ruby Devel 2.0.x or above
- Compass 1.0.x or above
- Node.js 6.0.x or above
- Bower 1.7.9 or above
- Grunt CLI 1.2.0 or above
- Access to a working instance of Traffic Ops
Traffic Portal Project Tree Overview¶
- traffic_control/traffic_portal/app/src - contains HTML, JavaScript and Sass source files.
Installing The Traffic Portal Developer Environment¶
- Clone the traffic_control repository
- Navigate to the traffic_control/traffic_portal of your cloned repository.
- Run
npm install
to install application dependencies into traffic_portal/node_modules. Only needs to be done the first time unless traffic_portal/package.json changes.- Run
bower install
to install client-side dependencies into traffic_portal/app/bower_components. Only needs to be done the first time unless traffic_portal/bower.json changes.- Run
grunt
to package the application into traffic_portal/app/dist, start a local https server (Express), and start a file watcher.- Navigate to https://localhost:8443
Notes¶
- The Traffic Portal consumes the Traffic Ops API. By default, Traffic Portal assumes Traffic Ops is running on https://localhost:8444. Temporarily modify traffic_portal/conf/config.js if you need to change the location of Traffic Ops.