Skip to content

oluwaetosin/drone-api

Repository files navigation

# Project Title

A Test Project With Musal Soft.

### Installing

* Clone the project from git@github.com:oluwaetosin/drone-api.git
* in the project folder run npm Install

## Build

* To Build and compile to javascript Run command: npm run tsc 
    This will generate a build folder in the /dist directory

## Test 
* To run the tests use  the command:
    npm test

## Run instruction

* To run the project use the command:
    npm run dev
    This will start the serer on http://locahost:8000
* The Supported API are as follows:
    * @api {get} http://locahost:8000/drones Get All Drones
    * @api {post} http://locahost:8000/drones Register A drone
    * api {post} http://locahost:8000/drones/load Load  A Droan With Medication Item
    * api {get} http://locahost:8000/drones/available Check Available Drones For Loading
    * api {get} http://locahost:8000/drones/:serial_number/medications  Check Loaded Medication For a Given Drone
    * api {get} http://locahost:8000/drones/:serial_number/battery_level Check Drone Battery Level
    * api {get} http://locahost:8000/drones/audit Check Drone Audit Record

* The request details is specified in src/routes/drones/drones.router.ts and 
can also be viewed on https://documenter.getpostman.com/view/340283/UVeNmNLg

  

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published