Mudra

Introduction

Mudra is a hand sign learning platform that aims to help people communicate with the Deaf and Mute.

Course and Challenge API

How to replicate

• Commands are done in terminal
• Ensure you have git installed on your machine. Use this command in terminal to ensure the git installation.
  git --version
  If you haven't installed git, please follow the instructions here to install git.
• Ensure you have nodejs installed on your machine. Use this command in terminal to ensure the nodejs installation.
  node -v
  If you haven't installed nodejs, please download it from here.
• After git is installed, clone this repo using this command
  git clone -b api https://github.com/faishalshidqi/capstone-api
• Ensure the cloned directory has a package.json file
• Install the nodejs dependencies using this command
  npm install
• Insert environment variables in the .env file Below a list of environment variables and their descriptions
  • PORT: port number to run the app
  • PGUSER: database username
  • PGHOST: database address
  • PGPASSWORD: database password
  • PGDATABASE: database name
  • PGPORT: database port
• Use this command to start the development server
  npm run start-dev
• Use this command to start the production server
  npm run start

Endpoints

• GET /courses
  supporting filter by type using query parameter ?type=
  supported value = ASL, BISINDO, SIBI
  for example: /courses?type=SIBI

Success Response (200 OK)

{
  "status": "text",
  "data": {
    "courses": [
      {
        "id": "text",
        "title": "text",
        "type": "text",
        "image_url": "text",
        "description": "long text",
        "created_at": "ISO Date text",
        "updated_at": "ISO Date text"
      },
      {
        "id": "text",
        "title": "text",
        "type": "text",
        "image_url": "text",
        "description": "long text",
        "created_at": "ISO Date text",
        "updated_at": "ISO Date text"
      }
    ]
  }
}

Fail Response (404 Not Found)

{
  "status": "text",
  "message": "text"
}

• GET /courses/{id}

Success Response (200 OK)

{
  "status": "text",
  "data": {
    "course": {
      "id": "text",
      "title": "text",
      "type": "text",
      "image_url": "text",
      "description": "long text",
      "created_at": "ISO Date text",
      "updated_at": "ISO Date text"
    }
  }
}

Fail Response (404 Not Found)

{
  "status": "text",
  "message": "text"
}

• GET /challenges
  supporting filter by type using query parameter ?type=
  supported value = ASL, BISINDO, SIBI
  for example: /challenges?type=SIBI

Success Response (200 OK)

{
  "status": "text",
  "data": {
    "challenges": [
      {
        "id": "text",
        "title": "text",
        "description": "long text",
        "course_id": "text",
        "answer": "text",
        "type": "text"
      },
      {
        "id": "text",
        "title": "text",
        "description": "long text",
        "course_id": "text",
        "answer": "text",
        "type": "text"
      }
    ]
  }
}

Fail Response (404 Not Found)

{
  "status": "text",
  "message": "text"
}

• GET /challenges/{id}

Success Response (200 OK)

{
  "status": "text",
  "data": {
    "challenge": {
      "id": "text",
      "title": "text",
      "description": "long text",
      "course_id": "text",
      "answer": "text",
      "type": "text"
    }
  }
}

Fail Response (404 Not Found)

{
  "status": "text",
  "message": "text"
}

Manager API

How to replicate

• All commands are done in terminal
• Ensure you have git installed on your machine. Use this command in terminal to ensure the git installation.
  git --version
  If you haven't installed git, please follow the instructions here to install git.
• Ensure you have nodejs installed on your machine. Use this command in terminal to ensure the nodejs installation.
  node -v
  If you haven't installed nodejs, please download it from here.
• After git is installed, clone this repo using this command
  git clone -b managers https://github.com/faishalshidqi/capstone-api
• Ensure the cloned directory has a package.json file
• Install the nodejs dependencies using this command
  npm install
• Use this command to start the development server
  npm run start-dev
• Use this command to start the production server
  npm run start

Endpoints

• GET /kll/courses
  supporting filter by type using query parameter ?type=
  supported value = ASL, BISINDO, SIBI
  for example: /kll/courses?type=SIBI

Success Response (200 OK)

{
  "status": "text",
  "data": {
    "courses": [
      {
        "course_id": "text",
        "title": "text",
        "sign_pict_link": "text",
        "description": "long text",
        "type": "text",
        "created_at": "ISO Date text",
        "updated_at": "ISO Date text",
        "is_deleted": "boolean"
      },
      {
        "course_id": "text",
        "title": "text",
        "sign_pict_link": "text",
        "description": "long text",
        "type": "text",
        "created_at": "ISO Date text",
        "updated_at": "ISO Date text",
        "is_deleted": "boolean"
      }
    ]
  }
}

Fail Response (404 Not Found)

{
  "status": "text",
  "message": "text"
}

• GET /kll/courses/info

Success Response (200 OK)

{
    "status": "text",
    "data": {
        "courses": [
            {
                "course_id": "text",
                "title": "text",
                "type": "text"
            }
        ]
    }
}

Fail Response (404 Not Found)

{
  "status": "text",
  "message": "text"
}

• GET /kll/courses/{id}

Success Response (200 OK)

{
  "status": "text",
  "data": {
    "course": {
      "course_id": "text",
      "title": "text",
      "sign_pict_link": "text",
      "description": "long text",
      "type": "text",
      "created_at": "ISO Date text",
      "updated_at": "ISO Date text",
      "is_deleted": "boolean"
    }
  }
}

Fail Response (404 Not Found)

{
  "status": "text",
  "message": "text"
}

• GET /kll/challenges
  supporting filter by type using query parameter ?type=
  supported value = ASL, BISINDO, SIBI
  for example: /kll/challenges?type=SIBI

Success Response

{
  "status": "text",
  "data": {
    "challenges": [
      {
        "challenge_id": "text",
        "title": "text",
        "description": "long text",
        "course_id": "text",
        "answer": "text",
        "created_at": "ISO Date text",
        "updated_at": "ISO Date text",
        "is_deleted": "boolean",
        "type": "text"
      },
      {
        "challenge_id": "text",
        "title": "text",
        "description": "long text",
        "course_id": "text",
        "answer": "text",
        "created_at": "ISO Date text",
        "updated_at": "ISO Date text",
        "is_deleted": "boolean",
        "type": "text"
      }
    ]
  }
}

Fail Response (404 Not Found)

{
  "status": "text",
  "message": "text"
}

• GET /kll/challenges/{id}

Success Response (200 OK)

{
  "status": "text",
  "data": {
    "challenge": {
      "challenge_id": "text",
      "title": "text",
      "description": "long text",
      "course_id": "text",
      "answer": "text",
      "created_at": "ISO Date text",
      "updated_at": "ISO Date text",
      "is_deleted": "boolean",
      "type": "text"
    }
  }
}

Fail Response (404 Not Found)

{
  "status": "text",
  "message": "text"
}

• POST /kll/courses

Body Payload

Content-Type: application/json

{
    "title": "text",
    "sign_pict_link": "text",
    "description": "text",
    "type": "text",
    "is_deleted": "boolean"
}

Success Response (200 OK)

{
    "status": "text",
    "message": "text",
    "data": {
        "course_id": "text"
    }
}

Fail Response (400 Bad Request)

{
  "status": "text",
  "message": "text"
}

• POST /kll/challenges

Body Payload

Content-Type: application/json

{
    "title": "text", 
    "description": "long text", 
    "course_id": "text", 
    "answer": "text", 
    "is_deleted": "boolean", 
    "type": "text"
}

Success Response (200 OK)

{
    "status": "text",
    "message": "text",
    "data": {
        "challenge_id": "text"
    }
}

Fail Response (400 Bad Request)

{
    "status": "text",
    "message": "text"
}

• PUT /kll/courses/{id}

Body Payload

Content-Type: application/json

{
  "title": "text",
  "sign_pict_link": "text",
  "description": "long text",
  "type": "text",
  "is_deleted": "boolean"
}

Success Response

{
    "status": "text",
    "message": "text"
}

Fail Response

{
    "status": "text",
    "message": "text"
}

• PUT /kll/challenges/{id}

Body Payload

Content-Type: application/json

{
    "title": "text", 
    "description": "long text", 
    "course_id": "text", 
    "answer": "text", 
    "is_deleted": "boolean", 
    "type": "text"
}

Success Response

{
  "status": "text",
  "message": "text"
}

Fail Response

{
  "status": "text",
  "message": "text"
}

• DELETE /kll/courses/{id}

Success Response

{
  "status": "text",
  "message": "text"
}

Fail Response

{
  "status": "text",
  "message": "text"
}

• DELETE /kll/challenges/{id}

Success Response

{
  "status": "text",
  "message": "text"
}

Fail Response

{
  "status": "text",
  "message": "text"
}

Uploads Service API

How to replicate

• All commands are done in terminal
• Ensure you have git installed on your machine. Use this command in terminal to ensure the git installation.
  git --version
  If you haven't installed git, please follow the instructions here to install git.
• Ensure you have nodejs installed on your machine. Use this command in terminal to ensure the nodejs installation.
  node -v
  If you haven't installed nodejs, please download it from here.
• After git is installed, clone this repo using this command
  git clone -b uploads-service https://github.com/faishalshidqi/capstone-api
• Ensure the cloned directory has a package.json file
• Install the nodejs dependencies using this command
  npm install
• Insert environment variables in the .env file Below a list of environment variables and their descriptions
  • PORT: port number to run the app
  • API_URL: course and challenge API url
  • BUCKET_NAME: Cloud Storage bucket name
• Use this command to start the development server
  npm run start-dev
• Use this command to start the production server
  npm run start

Endpoint

• POST /upload

Body Payload

Content-Type: multipart/form-data

{
  "file": "image/* file",
  "foldername": "text",
  "filename": "text"
}

Success Response (200 OK)

{
  "status": "text",
  "message": "text",
  "url": "text"
}

Another Success Response but resource denies public access

{
  "status": "text",
  "message": "text",
  "url": "text",
  "err": "json"
}

Fail Response

{
  "status": "text",
  "message":"text"
}

Hand Sign ML Call

How to replicate

• All commands are done in terminal
• Ensure you have git installed on your machine. Use this command in terminal to ensure the git installation.
  git --version
  If you haven't installed git, please follow the instructions here to install git.
• Ensure you have python installed on your machine. Use this command in terminal to ensure the python installation.
  python3 --version
  If you haven't installed python, please download it from here.
• After git is installed, clone this repo using this command
  git clone -b ml-call https://github.com/faishalshidqi/capstone-api
• Ensure the cloned directory has a requirements.txt file
• Install the python dependencies using this command
  pip3 install -r requirements.txt
• Insert environment variables in the .env file Below a list of environment variables and their descriptions
  • PORT: port number to run the app
• Use this command to start the development server
  flask run --host 127.0.0.1 --port <insert available port>
• Use this command to start the production server
  gunicorn --bind:<insert desired/available port> wsgi:app

Endpoint

• POST /predict

Body Payload

Content-Type: multipart/form-data

{
  "gambar": "image/* file",
  "type": "text"
}

Success Response (200 OK)

{
  "status": "text",
  "response": [
      {
        "Huruf": "text",
        "label_id": "text",
        "probability": "text"
      },
      {
        "Huruf": "text",
        "label_id": "text",
        "probability": "text"
      }
    ]
}

Manager Panel

How to replicate

• Commands are done in terminal
• Ensure you have git installed on your machine. Use this command in terminal to ensure the git installation.
  git --version
  If you haven't installed git, please follow the instructions here to install git.
• Ensure you have nodejs installed on your machine. Use this command in terminal to ensure the nodejs installation.
  node -v
  If you haven't installed nodejs, please download it from here.
• After git is installed, clone this repo using this command
  git clone -b manager-panel https://github.com/faishalshidqi/capstone-api
• Ensure the cloned directory has a package.json file
• Install the nodejs dependencies using this command
  npm install
• Insert environment variables in the .env file Below a list of environment variables and their descriptions
  • PORT: port number to run the app
  • API_URL: course and challenge API url
  • UPLOAD_URL: uploads service API url
• Use this command to start the development server
  npm run start-dev
• You have to build the project first to run production server. Use this command to build
  npm run build
• If you encounter an error because of lint issues, run this command and try to build again after that
  npm run lint
• Use this command to start the production server
  npm run start