mapillary-js/docs/developing.md

Developing mapillary-js

The following tools are required on any platform to develop mapillary-js.

• git
• node.js

To install dependencies

$ npm install

Development mode

$ gulp

If for some reason the tsd task fails during installation, please run it again manually before running gulp.

Then head to http://localhost:3000/ to debug (in case it did not open automatically)

Gulp Commands

@TODO

Project Structure

.
├── build/               - Development folder
├── debug/               - Access at localhost:3000 after `gulp`
├── dist/                - Distribution: CSS and other assets
├── spec/                - Tests
│   ├── Viewer.spec.ts
│   └── viewer
│       ├── OptionsParser.spec.ts
├── src/
│   ├── Mapillary.ts   - Main file
│   ├── Utils.ts       - Utility classes
│   ├── *.ts           - One file per class
│   └── api            - One folder per class
│       ├── interfaces
│       │   ├── IAPINavIm.ts
│       │   ├── IAPINavImIm.ts
│       │   ├── IAPINavImS.ts
│       │   └── interfaces.ts
│       ├── APINav.ts
│       ├── APIv2.ts
│       └── APIv2Call.ts
├── typings/
├── Gulpfile.js
├── karma.conf.js
├── package.json
├── tsd.json
├── tslint.json
└── README.md