Vehicle Tracking System

Table of contents

• Introduction
• Environment
• Tech Stack
• UI Layout
• How to run the application
• Issues
• References
• 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

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

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

UI Layout

Back to top

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 . For more information about how to clone the GitHub repository, see Cloning GitHub 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.

 <script async src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&loading=async&callback=Function.prototype&v=weekly"></script>

4. Start the Localhost server

Run the following command in your CLI to install all the rrequired packages:

npm install

Run the following command in your CLI to start the localhost server.

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:

npm run json-server

For more details about Json-server, please follow json-server documentation.

Back to top

Issues

• The application uses Google Maps services which requires the APK Key.
• The aplication uses JSON Server to simulate RESTful API.

Back to top

References

• For more information related to Angular setup, please check out the Angular documentation page.
• For more information related to Angular CLI, please check out the Angular CLI Overview and Command Reference page.
• For more information related to Node.js, please check out the Introduction to Node.js page.
• For more information related to Node Package Manager (NPM), please check out the npm Docs page.

Back to top

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