Skip to content

Commit

Permalink
Merge branch 'release/2.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
RaschidJFR committed Jan 22, 2021
2 parents 7380601 + 125fa91 commit 90a527e
Show file tree
Hide file tree
Showing 15 changed files with 10,307 additions and 7,336 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Contributing

* You'll find the library's source in [`/projects/ngx-googlemaps-tracking-view`](https://github.com/RaschidJFR/ngx-googlemaps-tracking-view/tree/master/projects/ngx-googlemaps-tracking-view).
* Find the source code for the demo app [`/demo`](https://github.com/RaschidJFR/ngx-googlemaps-tracking-view/tree/master/demo/Readme.md).

### Develop

1. `$ npm run watch` to build in watch mode,
2. then `$ npm run link:library` to install modules.
3. To launch the [demo app](https://github.com/RaschidJFR/ngx-googlemaps-tracking-view/tree/master/demo/Readme.md) (or your own app), link the module by running `$ npm link ngx-googlemaps-tracking-view` (from the app's root) after installing dependencies.

### Publish

1. Publish package: `$npm run publish`
2. Deploy demo and docs: `$ npm run deploy`
38 changes: 9 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A General-purpose embedded Angular map for tracking objects in real time using [Google Maps](https://developers.google.com/maps/documentation/javascript/tutorial). Helpful for Uber-like applications.

> For **Angular < 9.0** use version [@ng7](https://www.npmjs.com/package/ngx-googlemaps-tracking-view/v/1.5.0) of this package.
* [Live Demo](https://raschidjfr.github.io/ngx-googlemaps-tracking-view)
* [Documentation](https://raschidjfr.github.io/ngx-googlemaps-tracking-view/reference/components/NgxGooglemapsTrackingViewComponent.html)

Expand All @@ -13,7 +15,9 @@ A General-purpose embedded Angular map for tracking objects in real time using [

```html
<!-- component.html -->
<gmtv-map [data]="objectsToTrack"></gmtv-map>
<div style="height: 100%;">
<gmtv-map [data]="objectsToTrack"></gmtv-map>
</div>
```

```ts
Expand All @@ -25,27 +29,17 @@ const objectsToTrack: TrackedObject[] = [
id: '1',
color: 'blue',
heading: 45,
label: {text: 'Test object #1' },
label: { text: 'Test object #1' },
position: new google.maps.LatLng(19.53124, -96.91589),
},
{
id: '2',
color: 'red',
heading: -30,
label: {text: 'Test object #2' },
label: { text: 'Test object #2' },
position: new google.maps.LatLng(19.53144, -96.91523),
},
...
]
```

```scss
// styles.scss (Recomended)
body {
margin: 0;
height: 100vh;
}

];
```

## 🛠 Set Up
Expand Down Expand Up @@ -116,21 +110,7 @@ See [Full Documentation](https://raschidjfr.github.io/ngx-googlemaps-tracking-vi
```
## Contributing
Feel free to improve the code.
* Find the source code for the demo app [`/demo`](https://github.com/RaschidJFR/ngx-googlemaps-tracking-view/tree/master/demo/Readme.md).
* You'll find the library's source in [`/projects/ngx-googlemaps-tracking-view`](https://github.com/RaschidJFR/ngx-googlemaps-tracking-view/tree/master/projects/ngx-googlemaps-tracking-view).
* Develop:
1. `$ npm run watch` to build in watch mode,
2. then `$ npm run link:library` to install modules.
3. To launch the demo app, make sure you've installed the dependencies inside the [`/demo`](https://github.com/RaschidJFR/ngx-googlemaps-tracking-view/tree/master/demo/Readme.md) folder (check the [readme](https://github.com/RaschidJFR/ngx-googlemaps-tracking-view/tree/master/demo/Readme.md)) and link the module by running `$ npm link ngx-googlemaps-tracking-view` (from within the folder).
4. run `$ npm install` and `$ npm start` inside `/demo` to start the app.
* Publish:
1. Publish package: `$npm run publish`
2. Deploy demo and docs: `$ npm run deploy`
Feel free to improve the code: [CONTRIBUTING.md](./CONTRIBUTING.md).
## Credits
Raschid JF. Rafaelly
Expand Down
5 changes: 4 additions & 1 deletion angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,8 @@
}
}
},
"defaultProject": "ngx-googlemaps-tracking-view"
"defaultProject": "ngx-googlemaps-tracking-view",
"cli": {
"analytics": false
}
}
Loading

0 comments on commit 90a527e

Please sign in to comment.