mirror of
https://github.com/mapillary/mapillary-js.git
synced 2026-01-18 13:56:53 +00:00
58 lines
1.3 KiB
Markdown
58 lines
1.3 KiB
Markdown
## 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
|
||
```
|
||
|
||
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
|
||
│ └── Prefetcher.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
|
||
```
|