Skip to content

j-h-li/InclusiTravel

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

189 Commits
.gitlab
.gitlab
 
 
.vscode
.vscode
 
 
api
api
 
 
docs
docs
 
 
ghi
ghi
 
 
journals
journals
 
 
.env.sample
.env.sample
 
 
.flake8
.flake8
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
.gitlab-ci.yml
.gitlab-ci.yml
 
 
README.md
README.md
 
 
docker-compose.yaml
docker-compose.yaml
 
 
image.png
image.png
 
 
pyproject.toml
pyproject.toml
 
 

Repository files navigation

InclusiTravel

InclusiTravel is the ultimate destination for individuals who want to make informed choices when it comes to accessible locations. Whether you're a person with disabilities seeking accessible venues or a compassionate advocate for inclusivity, InclusiTravel empowers you to leave your mark and shape a more inclusive world.

How To Run This App

If the application is still deployed at the time of reading this README, the application can be accessed at the below link

If the application is no longer deployed the following software is required to run the application:

  • Git
  • Docker
  • Node.js

After confirming you have the needed software to run the application, follow the below steps to get the application running on your local machine.

  • Fork and clone this repository onto your computer.
  • Build the project and run the project in docker using the following commands:
    • docker volume create postgres-data
    • docker compose build
    • docker compose up
  • Open Docker desktop to confirm all containers are running.
  • Open the site on your browser at localhost:3000

##SQL table Relationships SQL Table Relationship

Comments

The Comments model in this application provides a set of CRUD APIs, allowing users to seamlessly manage and interact with comments associated with various content. These APIs empower users to Create new comments, Read existing comments, Update comment information, and Delete comments as needed. Below is a table of how you can access these endpoints and examples of expected input and output json responses.

Action Method URL
Get all review comments GET http://localhost:8000/reviews/{review_id}/comments
Get comment GET http://localhost:8000/reviews/comments/{comment_id}
Update comment (protected) PUT http://localhost:8000/reviews/comments/{comment_id}
Delete comment (protected) DELETE http://localhost:8000/reviews/comments/{comment_id}
Create comment (protected) POST http://localhost:8000/reviews/comments

Get all review comments

Input: review_id Response Body:

[
  {
    "id": 0,
    "account_id": 0,
    "content": "string",
    "created_on": "2023-09-06",
    "review": {
      "id": 0,
      "location_id": {
        "id": 0,
        "address": "string",
        "city": "string",
        "state": "string",
        "location_name": "string",
        "picture": "string",
        "updated_on": "2023-09-06"
      },
      "account_id": {
        "id": 0,
        "first_name": "string",
        "last_name": "string",
        "date_of_birth": "2023-09-06",
        "email": "string",
        "username": "string"
      },
      "rating": 0,
      "body": "string",
      "created_on": "2023-09-06"
    }
  }
]

Get comment

Input: comment_id Response Body:

{
  "id": 0,
  "account_id": 0,
  "content": "string",
  "created_on": "2023-09-06",
  "review": {
    "id": 0,
    "location_id": {
      "id": 0,
      "address": "string",
      "city": "string",
      "state": "string",
      "location_name": "string",
      "picture": "string",
      "updated_on": "2023-09-06"
    },
    "account_id": {
      "id": 0,
      "first_name": "string",
      "last_name": "string",
      "date_of_birth": "2023-09-06",
      "email": "string",
      "username": "string"
    },
    "rating": 0,
    "body": "string",
    "created_on": "2023-09-06"
  }
}

Update comment (protected)

Input: comment_id and below request body

{
  "account_id": 0,
  "review_id": 0,
  "content": "string",
  "created_on": "2023-09-06"
}

Response Body:

{
  "id": 0,
  "account_id": 0,
  "content": "string",
  "created_on": "2023-09-06",
  "review": {
    "id": 0,
    "location_id": {
      "id": 0,
      "address": "string",
      "city": "string",
      "state": "string",
      "location_name": "string",
      "picture": "string",
      "updated_on": "2023-09-06"
    },
    "account_id": {
      "id": 0,
      "first_name": "string",
      "last_name": "string",
      "date_of_birth": "2023-09-06",
      "email": "string",
      "username": "string"
    },
    "rating": 0,
    "body": "string",
    "created_on": "2023-09-06"
  }
}

Delete comment (protected)

Input: comment_id Response: True

Create comment (protected)

Request Body:

{
  "account_id": 0,
  "review_id": 0,
  "content": "string",
  "created_on": "2023-09-06"
}

Response Body:

{
  "id": 0,
  "account_id": 0,
  "content": "string",
  "created_on": "2023-09-06",
  "review": {
    "id": 0,
    "location_id": {
      "id": 0,
      "address": "string",
      "city": "string",
      "state": "string",
      "location_name": "string",
      "picture": "string",
      "updated_on": "2023-09-06"
    },
    "account_id": {
      "id": 0,
      "first_name": "string",
      "last_name": "string",
      "date_of_birth": "2023-09-06",
      "email": "string",
      "username": "string"
    },
    "rating": 0,
    "body": "string",
    "created_on": "2023-09-06"
  }
}

Reviews

Below you will find all the endpoints and examples of expected input and output JSON responses for the reviews model. These endpoints allow CRUD operations for the reviews.

Action Method URL
Get all accounts GET http://localhost:8000/api/reviews
Get review GET http://localhost:8000/api/reviews/{id}
Update review (protected) PUT http://localhost:8000/api/reviews/{id}
Delete review (protected) DELETE http://localhost:8000/api/reviews/{id}
Create review (protected) POST http://localhost:8000/api/reviews

Get all reviews

Response Body:

[
  {
    "id": 0,
    "location_id": {
      "id": 0,
      "address": "string",
      "city": "string",
      "state": "string",
      "location_name": "string",
      "picture": "string",
      "updated_on": "2023-09-06"
    },
    "account_id": {
      "id": 0,
      "first_name": "string",
      "last_name": "string",
      "date_of_birth": "2023-09-06",
      "email": "string",
      "username": "string"
    },
    "rating": 0,
    "body": "string",
    "created_on": "2020-02-12"
  }
]

Get review

Input: id

Response Body:

{
  "id": 0,
  "location_id": {
    "id": 0,
    "address": "string",
    "city": "string",
    "state": "string",
    "location_name": "string",
    "picture": "string",
    "updated_on": "2023-09-07"
  },
  "account_id": {
    "id": 0,
    "first_name": "string",
    "last_name": "string",
    "date_of_birth": "2023-09-07",
    "email": "string",
    "username": "string"
  },
  "rating": 0,
  "body": "string",
  "created_on": "2020-02-12"
}

Update review (protected)

Input: id

Request body:
{
  "location_id": 0,
  "account_id": 0,
  "rating": 0,
  "body": "string",
  "created_on": "2023-09-07"
}

Response Body:
{
  "id": 0,
  "location_id": {
    "id": 0,
    "address": "string",
    "city": "string",
    "state": "string",
    "location_name": "string",
    "picture": "string",
    "updated_on": "2023-09-07"
  },
  "account_id": {
    "id": 0,
    "first_name": "string",
    "last_name": "string",
    "date_of_birth": "2023-09-07",
    "email": "string",
    "username": "string"
  },
  "rating": 0,
  "body": "string",
  "created_on": "2022-01-01"
}

Delete review

Input: id

Response Body:
true

Create review (protected)

Request Body:
{
  "location_id": 0,
  "account_id": 0,
  "rating": 0,
  "body": "string",
  "created_on": "2023-09-07"
}

Response Body:

{
  "id": 0,
  "location_id": {
    "id": 0,
    "address": "string",
    "city": "string",
    "state": "string",
    "location_name": "string",
    "picture": "string",
    "updated_on": "2023-09-07"
  },
  "account_id": {
    "id": 0,
    "first_name": "string",
    "last_name": "string",
    "date_of_birth": "2023-09-07",
    "email": "string",
    "username": "string"
  },
  "rating": 0,
  "body": "string",
  "created_on": "2023-09-07"
}

Accounts

Below you will find all the endpoints and examples of expected input and output JSON responses for the accounts model. These endpoints allow CRUD operations for the accounts.

Action Method URL
Get all accounts GET http://localhost:8000/api/accounts
Get account GET http://localhost:8000/api/accounts/{username}
Create account POST http://localhost:8000/api/accounts

Get all accounts

Input: Blank

Response Body:

{
  "accounts": [
    {
      "id": 1,
      "first_name": "Bob",
      "last_name": "Ross",
      "date_of_birth": "1942-10-29",
      "email": "[email protected]",
      "username": "bobpaints"
    },
    {
      "id": 2,
      "first_name": "Stephen",
      "last_name": "Curry",
      "date_of_birth": "1988-03-14",
      "email": "[email protected]",
      "username": "stephshoots"
    }
  ]
}

Get account

Request Body:

Username: Stephshoots

Response Body:

{
  "id": 2,
  "first_name": "Stephen",
  "last_name": "Curry",
  "date_of_birth": "1988-03-14",
  "email": "[email protected]",
  "username": "stephshoots"
}

Create account

Request Body:

{
  "first_name": "string",
  "last_name": "string",
  "date_of_birth": "2023-09-07",
  "email": "string",
  "username": "string",
  "password": "string"
}

Response Body:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5N2I2NWM0My0zY2I5LTQwZjItODc3Mi04NDM3OTVjNTMyNjEiLCJleHAiOjE2OTQxMzM0MzMsInN1YiI6ImtjaDRuZyIsImFjY291bnQiOnsiaWQiOjU1LCJmaXJzdF9uYW1lIjoiS2F0ZWx5biIsImxhc3RfbmFtZSI6IkNoYW5nIiwiZGF0ZV9vZl9iaXJ0aCI6IjIwMjMtMDktMDciLCJlbWFpbCI6ImtjaGFuZ0BnbWFpbC5jb20iLCJ1c2VybmFtZSI6ImtjaDRuZyJ9fQ.M-B2bZHOEd8XKa_1AnkuQhePCvYFyDReH55WVwOk3Bg",
  "token_type": "Bearer",
  "account": {
    "id": 55,
    "first_name": "Katelyn",
    "last_name": "Chang",
    "date_of_birth": "2023-09-07",
    "email": "[email protected]",
    "username": "kch4ng"
  }
}

Accessibility

Below you will find all the endpoints and examples of expected input and output JSON responses for the accessibility model. These endpoints allow CRUD operations for the accessibilities.

Action Method URL
Get all accessibilities GET http://localhost:8000/api/acessibility
Create accessibility (protected) POST http://localhost:8000/api/acessibility

Get accessibility

Input: Blank

Response Body:

{
  "accessibilities": [
    {
      "id": 1,
      "name": "Ramps"
    },
    {
      "id": 2,
      "name": "Handicap Parking"
    },
    {
      "id": 3,
      "name": "crutches"
    },
    {
      "id": 4,
      "name": "Elevators"
    },
    {
      "id": 5,
      "name": "Escalators"
    }
  ]
}

Create accessibility (protected)

Request Body:

{
  "name": "string"
}

Response Body:

    {
      "id": 1,
      "name": "Ramps"
    }

Locations

The location model supports CRUD operations for locations, and the location-accessibility model is able to be used to get a list of accessibilities per location id and create and delete an association between an individual location and an individual accessibility. There is also an endpoint to get the average rating for a location. Below you will find all the endpoints and examples of expected inputs and outputs of JSON responses for the locations model and location-accessibility model.

Action Method URL
Get all locations GET http://localhost:8000/api/locations/
Get a location GET http://localhost:8000/api/locations/{location_id}
Create a location POST http://localhost:8000/api/locations/
Change a location PUT http://localhost:8000/api/locations/{location_id}
Delete a location DELETE http://localhost:8000/api/locations/{location_id}/
Get average rating of a location GET http://localhost:8000/api/locations/{location_id}/average_rating
Get list of accessibilities by location GET http://localhost:8000/api/locations/{location_id}/accessibilities
Create association between an accessibility and a location POST http://localhost:8000/api/locations/{location_id}/accessibilities/{accessibility_id}
Delete association between acccssibility and a location DELETE http://localhost:8000/api/locations/{location_id}/accessibilities/{accessibility_id}

Get a list of locations

Input: Blank

Response Body:

{
  "locations": [
    {
      "id": 0,
      "address": "string",
      "city": "string",
      "state": "string",
      "location_name": "string",
      "picture": "string",
      "updated_on": "2023-09-11"
    }
  ]
}

Create a location (protected end point)

Input:

{
  "address": "string",
  "city": "string",
  "state": "string",
  "location_name": "string",
  "picture": "string",
  "updated_on": "2023-09-11"
}

Response Body:

{
  "id": 0,
  "address": "string",
  "city": "string",
  "state": "string",
  "location_name": "string",
  "picture": "string",
  "updated_on": "2023-09-11"
}

Delete a location (protected end point)

Input: location id

Response Body:

true

Get a location

Input: location id

Response Body:

{
  "id": 0,
  "address": "string",
  "city": "string",
  "state": "string",
  "location_name": "string",
  "picture": "string",
  "updated_on": "2023-09-11"
}

Updte a location (protected endpoint)

Input: location id

{
  "address": "string1",
  "city": "string1",
  "state": "string1",
  "location_name": "string1",
  "picture": "string1",
  "updated_on": "2023-09-11"
}

Response Body:

{
  "id": 0,
  "address": "string1",
  "city": "string1",
  "state": "string1",
  "location_name": "string1",
  "picture": "string1",
  "updated_on": "2023-09-11"
}

Get list of accessibilities by location

Input: location id

Response Body:

{
  "accessibilities": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}

Create assocciation between an accessibility and a location (protected endpoint)

Input: location id and accessibility id

Response Body:

true

Delete assocciation between an accessibility and a location (protected endpoint)

Input: location id and accessibility id

Response Body:

true

Get average rating of a location

Input: location id

Response Body:

0

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 6

Languages