https://github.com/mystackbox/prj-vehicle-tracking-system
Angular 2+ framework application that allows a user to track, locate, and monitor vehicles on Google Maps based on the vehicle geolocation.
https://github.com/mystackbox/prj-vehicle-tracking-system
Last synced: 8 months ago
JSON representation
Angular 2+ framework application that allows a user to track, locate, and monitor vehicles on Google Maps based on the vehicle geolocation.
- Host: GitHub
- URL: https://github.com/mystackbox/prj-vehicle-tracking-system
- Owner: mystackbox
- License: mit
- Created: 2024-11-09T17:59:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-03T21:54:41.000Z (10 months ago)
- Last Synced: 2025-04-03T22:33:51.601Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 3.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vehicle Tracking System
# Table of contents
- [Introduction](#introduction)
- [Environment](#environment)
- [Tech Stack](#tech-stack)
- [UI Layout](#ui-layout)
- [How to run the application](#how-to-run-the-application)
- [Issues](#issues)
- [References](#references)
- [Licence](#licence)
# Introduction
Vehicle Tracking System was developed using `Angular 2+` framework. The application allows the user to track, locate, and monitor vehicles on Google Maps based on the vehicle geolocation. It keeps refreshing data every 30 seconds.
[Back to top](#table-of-contents)
# Environment
- Operating System - Windows 11
- Angular CLI - v18.2.11
- Visual Studio Code
- Node.js - v20.11.1
- Postman - testing the http methods.
- GitHub & Git Bash
[Back to top](#table-of-contents)
# Tech stack
- Responsive Web Design (HTML5, SCSS, Bootstrap5, FontAwesome, Lazy-loading).
- Angular/Typescript framework - v18.2.11
- Fetch API - v18.2.11
- Google Maps
- Json server (Mock API) - v1.0.0-alpha.3
[Back to top](#table-of-contents)
# UI Layout
[Back to top](#table-of-contents)
# How to run the application
### 1. Installation
Ensure that you have following items are installed in your computer:
- Visual Studio Code
- Node.js
- Angular CLI
### 2. Clone `GitHub` repository
Clone the project from Github repository into your local repository: [ Vehicle Tracking System ](https://github.com/mystackbox/prj-vehicle-tracking-system). For more information about how to clone the GitHub repository, see [Cloning GitHub repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
### 3. Update Google Maps API Key
Ensure that your in possession of Google Maps API Key. Open index.html in the source directory of the project and replace `YOUR_API_KEY` with your Google Maps API Key.
```javascript
```
### 4. Start the Localhost server
Run the following command in your `CLI` to install all the rrequired packages:
```javascript
npm install
```
Run the following command in your `CLI` to start the `localhost` server.
```javascript
ng serve
```
Once the `localhost` server is running, navigate to `http://localhost:4200/` or copy/paste `http://localhost:4200/` in your browser address-bar, then press enter.
### 5. Start the Mock API server
This application uses `json-server` Mock API to mimic real JSON RESTful services. To start json-server, run the following command:
```javascript
npm run json-server
```
For more details about Json-server, please follow [ json-server documentation](https://github.com/typicode/json-server).
[Back to top](#table-of-contents)
# Issues
- The application uses Google Maps services which requires the APK Key.
- The aplication uses JSON Server to simulate RESTful API.
[Back to top](#table-of-contents)
# References
- For more information related to Angular setup, please check out the [Angular documentation](https://angular.io/docs) page.
- For more information related to Angular CLI, please check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
- For more information related to Node.js, please check out the [Introduction to Node.js](https://nodejs.org/en/learn/getting-started/introduction-to-nodejs) page.
- For more information related to Node Package Manager (NPM), please check out the [npm Docs](https://docs.npmjs.com/) page.
[Back to top](#table-of-contents)
# Licence
MIT License
Copyright (c) 2024 | Yingisani
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE..
[Back to top](#table-of-contents)