Table of contents

• Setup
  • Build and run Application
  • Run Drone simulator
  • Run tests
• Documentation
  • Requirements, Constraints and Overall Design
  • Location Tracker - Requirements, Constraints, Design and API documentation
  • Backend - Requirements, Design and API Documentation
  • Drone Simulator
• Dev Tools

Setup

Build and run Application

1. Build Image docker build -f Dockerfile.dev -t dsinecos/drone-location-tracker .

2. Run container docker run -it -p 5000:5000 -p 6000:6000/udp -v /usr/app/node_modules -v $(pwd):/usr/app --name=drone-location-tracker dsinecos/drone-location-tracker

3. Run a shell process inside the container

   • Open another terminal
   • docker exec -it drone-location-tracker sh

Run Drone simulator

1. Run container using the command in the earlier section (docker run ...)

2. Go to localhost:5000 on your browser

3. Open another terminal

   • docker exec -it drone-location-tracker yarn run simulation

Run tests

1. Run container using the command in the earlier section (docker run ...)

2. docker exec -it drone-location-tracker yarn run test

Documentation

Requirements, Constraints and Overall Design

Location Tracker - Requirements, Constraints, Design and API documentation

Backend - Requirements, Design and API Documentation

Drone Simulator

Dev Tools

Tool	Objective
Git (CLI) GitKraken (GUI)	Version control
Yarn	Dependency management
Docker	Containerization
ESLint	Code Linting
JSDoc	Documentation
Testing
Mocha	Test runner
Chai	Assertion library
Sinon	For mocking and stubbing
Nodemon	Auto-restarting app
Debug	Logging during development
Dotenv	Setup environment variables