A CodeCree project as part of the Knightshield Hackathon
Briefing: Create an app of any kind that utilizes the latest technolgy and has an innovative way of tracking packages and shipping!
Note: This project hasn't been fully completed due to the time constraints and the fact that we didn't start coding until the Wednesday due to other commitments.
- Project Name: Deliverly
- Short Project Description: An app to track drivers and packages
- Team Name: CodeCree
- Team Members: Max @maxtrewartha, Josh @joshheng
- Demo Link: https://staging.codecree.co.uk
- Repository Link: Deliverly Frontend and Deliverly Backend
- Labels: Single page web app (mobile friendly)
Deliverly is an app to track drivers and packages as they travel accross routes between warehouses to their final destination. Operators (admins) can track the locations of all their drivers and manage both drivers and warehouses. Packages have a three word code which can be tracked by the customer in addition to a QR code used by the driver.
Endpoint is localhost:3000/api
The endpoint will only receive and send data in JSON formatting
Checks to see if the api is online Auth type required: NONE
{
"success": true,
"message": "Online"
}Checks to see if the api is online
Auth type required: NONE
{
"success": true,
"data": [
"2d946ef3-9c4d-4229-aaea-5cf54b1e1727",
"13c58d87-809f-4ce5-b70b-4a32356c68c4",
"bd1e27c6-8bdc-43c9-a522-79e49f055793",
"and 12 more of these"
]
}Registers a new user into a database
Auth type required: AUTH TOKEN OPERATOR ONLY
Auth location: HEADER "Authorization"
{
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"password": "password"
}{
"success": true
}In this example, the password doesn't meet the requirement if being at least 8 letters long
{
"success": false,
"error": "\"password\" length must be at least 8 characters long"
}Logs a user in if the account exists on the database
Auth type required: EMAIL & PASSWORD
Auth location: JSON BODY
{
"email": "[email protected]",
"password": "password"
}{
"success": true,
"email": "[email protected]",
"operator": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZjIyMDgxYTI3MDllZDIzYjgzYWJhMmUiLCJvcGVyYXRvciI6dHJ1ZSwiaWF0IjoxNTk2MTQ4ODc3fQ.vgDnt0WkbBbEZrP5YNZTgWuqNg4ycZIIJFRXQApLBi0"
}In this example, the password is wrong
{
"success": false,
"message": "Email or password is incorrect"
}Checks to make sure a user is logged in
Auth type required: AUTH TOKEN ANY
Auth location: HEADER "Authorization"
GET localhost:3000/api/user/me
{
"success": true,
"data": {
"email": "[email protected]",
"operator": true
}
}In this example, the token is invalid
{
"success": false,
"message": "Invalid token"
}Gets a list of all none operator users
Auth type required: AUTH TOKEN OPERATOR ONLY
Auth location: HEADER "Authorization"
localhost:3000/api/user
{
"success": true,
"data": [
{
"operator": false,
"_id": "5f23f6cbf0e0e028c074588d",
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]"
},
{
"operator": false,
"_id": "5f240ad1b058dd2fdb194e30",
"firstName": "Romeo",
"lastName": "Montague",
"email": "[email protected]"
}
]
}Post a new package to the server
Auth type required: AUTH TOKEN ANY
Auth location: HEADER "Authorization"
{
"warehouse": "000001",
"weight": "1.22",
"email": "[email protected]",
"recipient": "John Doe",
"address": {
"street": "10 Downing Street",
"city": "London",
"postcode": "SW1A 2AA"
}
}{
"recipient": "John Doe",
"email": "[email protected]",
"address": {
"street": "10 Downing Street",
"town": "Westminster",
"city": "London",
"postcode": "SW1A 2AA"
},
"collect": {
"street": "Buckingham Palace",
"town": "Westminster",
"city": "London",
"postcode": "SW1A 1AA"
},
"premium": "1596139634268"
}{
"success": true,
"customerCode": "historian-broach-courtesan",
"id": "5f2328b11d4da55e54991276"
}In this example, the Google Geolocate API key is invalid
{
"success": false,
"message": "The provided API key is invalid."
}Get package information
Auth type required: AUTH TOKEN ANY
Auth location: HEADER "Authorization"
GET localhost:3000/api/package/stop-amble-oviparous
{
"success": true,
"data": {
"code": "stop-amble-oviparous",
"weight": 1.22,
"recipient": "John Doe",
"email": "[email protected]",
"address": {
"coordinates": [
51.5034,
-0.1276
],
"_id": "5f234d15f9424b3c403e23ab",
"street": "10 Downing Street",
"city": "London",
"postcode": "SW1A 2AA"
},
"events": []
}
}In this example, the package does not exist
{
"success": false,
"message": "Package does not exist"
}Create a new warehouse
Auth type required: AUTH TOKEN OPERATOR ONLY
Auth location: HEADER "Authorization"
{
"name": "Warehouse Bravo Mark 2",
"address": {
"street": "14 Downing Street",
"city": "London",
"postcode": "SW1A 2AA"
}
}The data is the new list of warehouses
{
"success": true,
"id": "269bda92-d98b-4a8c-a1ed-6d5f658831b5",
"data": [
{
"_id": "5f2343f6966c154de8f3e7a0",
"uuid": "d1a0654d-bc5d-44d2-b3f0-d8df10d8d62b",
"name": "Warehouse Bravo Mark 2",
"address": {
"coordinates": [
51.5032,
-0.1281
],
"_id": "5f2343f6966c154de8f3e79f",
"street": "14 Downing Street",
"city": "London",
"postcode": "SW1A 2AA"
},
"__v": 0
}
]
}In this example, the header has an invalid token
{
"success": false,
"message": "Invalid token"
}Get all the warehouse information
Auth type required: AUTH TOKEN ANY
Auth location: HEADER "Authorization"
GET localhost:3000/api/warehouses
{
"success": true,
"data": [
{
"_id": "5f2343f6966c154de8f3e7a0",
"uuid": "d1a0654d-bc5d-44d2-b3f0-d8df10d8d62b",
"name": "Warehouse Bravo Mark 2",
"address": {
"coordinates": [
51.5032,
-0.1281
],
"_id": "5f2343f6966c154de8f3e79f",
"street": "14 Downing Street",
"city": "London",
"postcode": "SW1A 2AA"
},
"__v": 0
},
{
"_id": "5f234d87f9424b3c403e23b0",
"uuid": "269bda92-d98b-4a8c-a1ed-6d5f658831b5",
"name": "Amazing warehouse v3",
"address": {
"coordinates": [
51.5032,
-0.1281
],
"_id": "5f234d87f9424b3c403e23af",
"street": "14 Downing Street",
"city": "London",
"postcode": "SW1A 2AA"
},
"__v": 0
}
]
}Get warehouse information
Auth type required: AUTH TOKEN ANY
Auth location: HEADER "Authorization"
GET localhost:3000/api/warehouse/d1a0654d-bc5d-44d2-b3f0-d8df10d8d62b
{
"success": true,
"data": {
"uuid": "d1a0654d-bc5d-44d2-b3f0-d8df10d8d62b",
"name": "Warehouse Bravo Mark 2",
"address": {
"coordinates": [
51.5032,
-0.1281
],
"_id": "5f2343f6966c154de8f3e79f",
"street": "14 Downing Street",
"city": "London",
"postcode": "SW1A 2AA"
}
}
}In this example, the warehouse does not exist on the database
{
"success": false,
"message": "Warehouse does not exist"
}Creates a new route
Auth type required: AUTH TOKEN ANY
Auth location: HEADER "Authorization"
{
"endWarehouse": "d1a0654d-bc5d-44d2-b3f0-d8df10d8d62b"
}{
"success": true
}In this example, the warehouse does not exist
{
"success": false,
"error": "Warehouse does not exist"
}Gets all routes
Auth type required: AUTH TOKEN OPERATOR ONLY
Auth location: HEADER "Authorization"
GET localhost:3000/api/routes/all
{
"success": true,
"data": [
{
"startedAt": null,
"endedAt": null,
"_id": "5f2379ad1eebe0cb2f59321a",
"userId": "5f22081a2709ed23b83aba2e",
"endWarehouse": "d1a0654d-bc5d-44d2-b3f0-d8df10d8d62b",
"packages": [],
"tracking": [],
"__v": 0
},
{
"startedAt": null,
"endedAt": null,
"_id": "5f23f5fe9ac57ec0e71e4dc0",
"userId": "5f22081a2709ed23b83aba2e",
"endWarehouse": "269bda92-d98b-4a8c-a1ed-6d5f658831b5",
"packages": [],
"tracking": [],
"__v": 0
}
]
}Gets all route info for current user