This is the repository for the RouteFinder CoE project for Unosquare
RouteFinder is a route generation tool designed to allow users to generate GPS routes for sport related activities, such as running and cycling. Routes can be generated by specifying parameters, such as a start location, distance, maximum/minimum elevation in route, type of terrain and whether the route should be an end to end sprint or a circuit. Users can generate routes and save them to their profile, which in turn can be shared via a URL link or be marked as public routes. Users can also search for routes or do an area search with optional filter parameters. To aggregate good routes, users can like and favourite routes so that quality routes are given more visibility. On completion of a route users should be able to rate the route or submit a review describing the experience of the route. At a bare minimum, users should be able specify the difficulty of the route but this can be expanded for other metrics such as views and fun factor.
This application is intended for running and/or cycling atheletes who may use GPS tracking technology while exercising. However, the application can also be used for other sports, such as hiking. The point of this application is to give a potential user the means to generate routes in an area they may not be familiar with or generate potential ideas for a new route as part of a new training routine. Likewise it can be used to aggregate popular routes used in a certain area. A similar feature for generating routes exists in the fitness social media app Strava (https://www.strava.com/) however, this app focuses solely on the generation and sharing of routes, a routes database if you will, rather than being an athelete-orientated social media app.
Access and features available in the app will depend if the user has an account or not. If the user does not have an account, they can search for routes by typing in an address or city/town name and specify a maximum range around the aforementioned location. If the user is logged in, they can login to the app an access a user dashboard. This dashboard will show the user their saved routes and the option to generate new routes. When generating new routes, the user will pick a starting location, and whether the route will be a circuit (where it will end at the start point) or a sprint (where the route will end at a different location). If sprint is selected, the user can optionally specify where the route will end. After this, the user can specify parameters such as how hilly the route will be, the desired length and what sort of terrain to use. An example of this would be choosing to avoid main roads or focus on offroad tracks only.
- User clicks "Generate route"
- User is asked to select a start location.
- This can be done by typing in an address or dropping a pin on a map.
- User is shown radio button option to generate either a circuit route or a sprint route.
- User can also optionally specify if the route is meant for running or cycling.
- User is shown a map and a list of parameters to adjust route generation.
- User clicks "Generate route".
- The user can generate a route and make adjustments as they see fit until they are happy with the given route.
- User clicks "Save route".
- The route is saved on the backend and stored as one of the user's route.
- The user goes to the root homepage.
- The user types into a search bar a location, which can also be an address.
- The user can optionally apply filters, such as a minimum length, maximum total elevation, running route or cycling route etc.
- The user will get a selection of routes based on their search criteria.
- The user can view these routes by clicking on them, which will bring them to the view route page.
- Create user account and password
- Create route with the following parameters
- Length
- Circuit or route
- Maximum elevation
- Store saved routes to a user's profile.
- View routes on a view route page.
- Allow users to specify either a cycling route or a running route
- Allow users to search for routes with filters
- Allow users to search or the following parameters
- Terrain prioritization
- Queue up different towns as "checkpoints"
-
- Allow users to rate routes on a likes system.
- Allow users to label routes with tags, ie: labelling a route as "hilly". Users can use this to filter routes.
- Upload photo for route as well as user.
- Allow users to report on routes upon completion using a review system.
- Allow users to upload custom routes using GPX files.
- Export routes from 3rd party services, such as strava.
User: The user represents a person who has a registered account in the system. The user will have a role assigned which will grant them different access levels on the site.
Role: The Role is a User's role, which grants users different permissions. To begin with, there will be only two tracked roles in the system.
Route: The Route represents information about a generated route in the system, which will be done procedurally.
Review: The Review represent a user-submitted review of a particular route. The route can optionally be associated with a rating, but it is not required to submit a review.
PlotPoint: A plot-point is a coordinate that is associated with a route that when combined together will create a route. Plot-points will contstruct the route based on their order. A route will need many plotpoints to correctly display a route.
Rating: A rating is an review aggregator that allows users to rate the quality of a route. A route may have many ratings.
Tag: A tag is a label that can be applied to many different routes. Tags are used to label routes and can be used to search for specific types of routes in the system.
erDiagram
user ||--o{ role : has
user ||--o{ route : creates
user ||..o{ review : posts
user ||..o{ rating : posts
route ||..o{ rating : holds
route ||..o{ review : has
route ||--o{ plotpoint: has
user }o..o{ tag: creates
route }o..o{ tag: has
erDiagram
user ||--o{ route : creates
user ||..o{ review : posts
user ||..o{ rating : posts
route ||..o{ rating : holds
route ||..o{ review : has
route ||--o{ plotpoint: has
route ||--o{ type: has
route }o..o{ route_tag: has
tag }o..o{ route_tag: has
user {
guid id PK
string email_address
string first_name
string last_name
string password
string role
date date_of_birth
timestamp created
timestamp last_modified
}
type {
serial id PK
string name
timestamp created
timestamp last_modified
}
route {
guid id PK
string route_name
timestamp created
timestamp last_modified
serial type_id FK
guid user_id FK
}
review {
guid id PK
string content
timestamp created
timestamp last_modified
guid route_id FK
guid user_id FK
}
plotpoint {
guid id PK
float x_coordinate
float y_coordinate
string description
integer order
timestamp created
timestamp last_modified
guid route_id FK
}
rating {
guid id PK
double rating
date created
date last_modified
guid user_id FK
guid route_id FK
}
tag {
guid id PK
string name
timestamp created
timestamp last_modified
}
route_tag {
serial id PK
timestamp created
timestamp last_modified
guid route_id FK
guid tag_id FK
}
POST /auth Authenticates a given user
Response 200 OK
Request
{
"email": "[email protected]",
"password": "password"
}Response
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5"
}GET /users Returns a list of all user accounts in the system
Response
[
{
"id": "fccc2225-e05e-45dd-b1ad-27424c8be9e0",
"first_name": "Randall",
"last_name": "Sand",
"email": "[email protected]",
"role": "USER"
},
{
"id": "a481ea30-9580-4e55-a478-1353682cf0ba",
"first_name": "Jane",
"last_name": "Smith",
"email": "[email protected]",
"role": "ADMIN"
}
]GET /users/{userId} returns the user associated with the guid.
Response
{
"id": "fccc2225-e05e-45dd-b1ad-27424c8be9e0",
"first_name": "Randall",
"last_name": "Sand",
"email": "[email protected]",
"role": "USER"
}GET /users/{userId}/routes Return a list of routes associated with the user account.
Response
[
{
"id": "edc229be-832b-4743-8073-255124c7c50b",
"route_name": "Glenmore Forest Run",
"created": "2022-06-02 12:04:45",
"last_modified": "2022-11-24 15:34:01",
"user_id": "fccc2225-e05e-45dd-b1ad-27424c8be9e0",
"type": {
"id": "1",
"name": "Running",
"created": "2022-06-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
}
},
{
"id": "dfcf697f-5087-4131-897d-43649acb729c",
"route_name": "North 500",
"created": "2022-08-02 12:04:45",
"last_modified": "2022-10-24 15:34:01",
"user_id": "fccc2225-e05e-45dd-b1ad-27424c8be9e0",
"type": {
"id": "2",
"name": "Cycling",
"created": "2022-06-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
}
},
]POST /users Adds a user to the system
Response - 201 - created
Request
{
"first_name": "Randall",
"last_name": "Sand",
"date_of_birth": "12/12/1994",
"email": "[email protected]",
"role": "USER"
}{
"id": "2e30455f-306b-43cb-8916-21003a949300"
}DELETE /user/{userId} Deletes a user given a valid user id.
Response - 204 No Content/Deleted
PUT /user/{userId} Updates a user with a given id
Response - 204 No Content/Updated
Request
{
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "12/12/1994",
"email": "[email protected]",
"role": "ADMIN"
}GET /routes/ Gets all routes in the system
Response
[
{
"id": "edc229be-832b-4743-8073-255124c7c50b",
"route_name": "Glenmore Forest Run",
"created": "2022-06-02 12:04:45",
"last_modified": "2022-11-24 15:34:01",
"user_id": "fccc2225-e05e-45dd-b1ad-27424c8be9e0",
"type": {
"id": "1",
"name": "Running",
"created": "2022-06-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
}
},
{
"id": "dfcf697f-5087-4131-897d-43649acb729c",
"route_name": "North 500",
"created": "2022-08-02 12:04:45",
"last_modified": "2022-10-24 15:34:01",
"user_id": "fccc2225-e05e-45dd-b1ad-27424c8be9e0",
"type": {
"id": "2",
"name": "Cycling",
"created": "2022-06-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
}
},
{
"id": "78b6e504-0d47-46c2-a070-ae928cbc09f0",
"route_name": "Town run",
"created": "2022-08-02 12:04:45",
"last_modified": "2022-10-24 15:34:01",
"user_id": "6de5ff17-8162-4a44-be51-4c3576871952",
"type": {
"id": "2",
"name": "Running",
"created": "2022-07-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
}
}
]GET routes/{routeId} Gets a single route in the system. This will also include the plotpoints, if any.
Response
{
"id": "78b6e504-0d47-46c2-a070-ae928cbc09f0",
"route_name": "Town run",
"created": "2022-08-02 12:04:45",
"last_modified": "2022-10-24 15:34:01",
"user_id": "6de5ff17-8162-4a44-be51-4c3576871952",
"type_id": 2,
"plotpoints": [
{
"id": "aa13de12-b627-4479-b186-028be7ff938b",
"x_coordinate": 354.32324,
"y_coordinate": 643.23424,
"description": "Start location at townsville square",
"order": 1,
"created": "2022-07-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
},
{
"id": "30587dcd-5a60-48a1-8564-b6e7691d6663",
"x_coordinate": 356.38327,
"y_coordinate": 647.10124,
"description": "End location at townie bridge",
"order": 2,
"created": "2022-07-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
},
]
}POST /routes Creates a single route. In the example below, plotpoints are included but are not required to create the route.
Response - 202 OK
Request
{
"route_name": "Country run",
"created": "2022-09-02 12:04:45",
"last_modified": "2022-10-24 15:34:01",
"user_id": "6de5ff17-8162-4a44-be51-4c3576871952",
"type": {
"id": "2",
"name": "Running",
"created": "2022-07-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
},
"plotpoints": [
{
"id": "aa13de12-b627-4479-b186-028be7ff938b",
"x_coordinate": 354.32324,
"y_coordinate": 643.23424,
"description": "Start location at townsville forest",
"order": 1,
"created": "2022-07-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
},
{
"id": "30587dcd-5a60-48a1-8564-b6e7691d6663",
"x_coordinate": 356.38327,
"y_coordinate": 647.10124,
"description": "End location at townie hill",
"order": 2,
"created": "2022-07-02 13:35:00",
"last_modified": "2022-10-12 16:30:00"
},
]
}PUT /routes/{routeId} Updates a single route with a valid id.
Response - 204 - Updated
Request
{
"name": "new route name",
"type_id": 2
}DELETE /routes/{routeId} Deletes a route given a valid route id.
Response - 204 No Content/Deleted
POST /routes/{routeId}/plotpoints Adds a new plotpoint to an existing route. Multiple plotpoints can be added in one request.
Response - 202 Created
{
"id": "342"
}Request
[
{
"x_coordinate": 65.2343,
"y_coordinate": 20.3421,
"description": "Woodland",
}
]UPDATE /routes/{routeId}/plotpoints/{plotPointId} Updates a given plotpoint
Response - 204 - No Content
Request
{
"id": "342",
"x_coordinate": 65.2343,
"y_coordinate": 20.3421,
"description": "Forestland",
}DELETE /routes/{routeId}/plotpoints/{plotPointId} Deletes a given plotpoint. The ordering of all remaining plotpoints will be updated.
Response - 204 - No Content