Cloud Computing Documentation

List of Documentation

Tech Stack
Database Relational
API Endpoint

Tech Stack Used

back to top

Backend Stack

Hapi.js
Json Web Token (JWT)
Bcrypt (Algorithm)
Sequelize (ORM)
MySQL (Database)
Firebase Realtime Database (chat feature)
Postman (API Testing)

Cloud Stack

For deployment we use Google Cloud Platform (GCP).

Here are the cloud architecture details

Cloud Build
Cloud Run
Cloud SQL
Cloud Storage

Here are the environment variables we created:

var	Description
DB_HOST	contains the host address for connection to the database.
DB_NAME	contains the database name for connection to the database.
DB_USERNAME	contains the database username to access the database.
DB_PASSWORD	contains the database password to access the database.
_SERVICE_ACCOUNT_KEY	contains the credential value of the GCP service account key.json.

CI/CD Deployment

Implementing CI/CD Pipeline with Google Cloud. Create Triggers in Cloud Build that connect to Github repositories with manual event trigger invocation. In the repository, there is already a Dockerfile that contains instructions for creating a container image. The configuration that connects to Cloud Build is in the cloudbuild.yaml file. In the file there is a command that directly wraps the code into a container image, then pushes it to the Container Registry, and finally deploying with Cloud Run. So later on Triggers, there is a Run button to run a manual call.

Database Relational

back to top

Endpoint URL

https://backend-xxsx62riha-et.a.run.app/

Auth and User Endpoint

back to top

1. Register

URL:
- /register
Method:
- POST
Description:
- Register a new user.
Request Body:
- username as string, must be unique
- password as string
- name as string
- email as string, must be email type
- pref_categories as string

Response:

 {
    "status": "success",
    "message": "Registrasi berhasil",
    "user": {
        "id": 13,
        "username": "aa",
        "password": "$2b$10$w3q9AiuEfVdjLb90FvJDo.ycm1BhRryekzFqqpeGlqc7TUOwZNF4G",
        "name": "Huruf A",
        "email": "aaaa@gmail.com",
        "pref_categories": "Politik | Sosial"
    }
}

2. Login

URL:
- /login
Method:
- POST
Description:
- authenticate a user based on the database.
Request Body:
- username as string
- password as string

Response:

{
  "status": "success",
  "message": "Login berhasil",
  "user": {
  "username": "user",
  "name": "User Baru",
  "email": "user@gmail.com",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InVzZXIiLCJpYXQiOjE2ODU0MDgxMTYsImV4cCI6MTY4NTQxMTcxNn0.eRwhWf2DgSOgc-W4HeY1tbjyrOa82M24zowUsMs9aZQ"
  },
}

3. Profil

URL:
- /profil/:username
Method:
- GET
Description:
- to get logged in user data.
Request Body:
- username as string
- password as string
Header:
- Authorization: Bearer {token}
Parameters:
- username as string, required

Response:

{
  "status": "success",
  "message": "Username berhasil ditemukan",
  "user": {
  "id": 4,
  "username": "user",
  "name": "User Baru",
  "email": "user@gmail.com",
  "last_login": "2023-05-30T07:55:16.459Z"
  }
}

Category Endpoint

back to top

1. Kategori

URL:
- /kategori
Method:
- GET
Description:
- to get all category data
Header:
- Authorization: Bearer {token}

Response:

{
  "status": "success",
  "message": "Daftar kategori berhasil ditemukan",
  "categories": [
    {
    "id": 1,
    "nm_kategori": "Sosial"
    },
    {
    "id": 2,
    "nm_kategori": "Pendidikan"
    },
    {
    "id": 3,
    "nm_kategori": "Kesehatan"
    },
    {
    "id": 4,
    "nm_kategori": "Budaya"
    },
    {
    "id": 5,
    "nm_kategori": "Politik"
    }
  ]
}

Project Endpoint

back to top

1. Create Project

URL:
- /proyek
Method:
- POST
Description:
- to create project
Header:
- Authorization: Bearer {token}
Request Body:
- username as string, must be unique
- id_kategori as int
- tanggal_mulai as date
- tanggal_selesai as date
- file as file, must be a valid image file, max size 2mb

Response:

{
  "status": "success",
  "message": "Project berhasil dibuat",
  "project": {
      "status": "terbuka",
      "total_rate": 0,
      "jumlah_raters": 0,
      "mean_rate": 0,
      "id": 4,
      "creator": "deo",
      "nm_proyek": "Platform E-Learning",
      "id_kategori": 1,
      "deskripsi": "ini adalah aplikasi elearning ruangbelajar",
      "gambar": "https://storage.googleapis.com/project-img/3iribYxloRspFA-jNa-Mi.jpeg",
      "tanggal_mulai": "2023-05-29T00:00:00.000Z",
      "tanggal_selesai": "2023-07-29T00:00:00.000Z"
  }
}

2. Get All Projects

URL:
- /proyek
Method:
- GET
Description:
- to get all created project data order by tanggal_mulai ascending
Header:
- Authorization: Bearer {token}

Response:

{
  "status": "success",
  "message": "Daftar Project berhasil ditemukan",
  "projects": [
      {
          "id": 1,
          "creator": "deo",
          "nm_proyek": "Platform Crowdsourcing untu Masyarakat Jawa",
          "id_kategori": 1,
          "deskripsi": "ini adalah aplikasi mirip idekita hehe",
          "gambar": "https://storage.googleapis.com/project-img/3iribYxloRspFA-jNa-Mi.jpeg",
          "tanggal_mulai": "2023-05-22",
          "tanggal_selesai": "2023-08-22",
          "status": "selesai",
          "total_rate": 12,
          "jumlah_raters": 3,
          "mean_rate": 4,
          "category": {
              "nm_kategori": "Sosial"
          }
      }
  ]
}

3. Detail Project

URL:
- /proyek/:id_proyek
Method:
- GET
Description:
- to get project data by id project
Header:
- Authorization: Bearer {token}
Parameters:
- id_proyek as int, required

Response:

{
  "status": "success",
  "message": "Daftar Project berhasil ditemukan",
  "projects": [
      {
          "id": 4,
          "creator": "deo",
          "nm_proyek": "Platform E-Learning",
          "id_kategori": 1,
          "deskripsi": "ini adalah aplikasi elearning ruangbelajar",
          "gambar": "https://storage.googleapis.com/project-img/3iribYxloRspFA-jNa-Mi.jpeg",
          "tanggal_mulai": "2023-05-29",
          "tanggal_selesai": "2023-07-29",
          "status": "terbuka",
          "total_rate": 0,
          "jumlah_raters": 0,
          "mean_rate": 0,
          "category": {
              "nm_kategori": "Sosial"
          }
      }
  ]
}

4. Get Project By Category

URL:
- /proyek/kategori/:kategori
Method:
- GET
Description:
- to get project based on category
Header:
- Authorization: Bearer {token}
Parameters:
- kategori as string, required

Response:

{
  "status": "success",
  "message": "Daftar Project berhasil ditemukan",
  "projects": [
      {
          "id": 1,
          "creator": "deo",
          "nm_proyek": "Platform Crowdsourcing untuk Masyarakat",
          "id_kategori": 1,
          "deskripsi": "ini adalah aplikasi mirip idekita hehe",
          "gambar": "https://storage.googleapis.com/project-img/3iribYxloRspFA-jNa-Mi.jpeg",
          "tanggal_mulai": "2023-05-22",
          "tanggal_selesai": "2023-08-22",
          "status": "selesai",
          "total_rate": 12,
          "jumlah_raters": 3,
          "mean_rate": 4
      },
  ]
}

5. Get My Project Based on Status

URL:
- /proyek/kategori/:kategori
Method:
- GET
Description:
- to get project where status is in progress or status is done
Header:
- Authorization: Bearer {token}
Parameters:
- status as string, valid : 'berlangsung','selesai' ,required

Response: this is just an example for status = 'in progress'

{
  "status": "success",
  "message": "Daftar Project berhasil ditemukan",
  "projects": [
      {
          "id": 2,
          "creator": "deo",
          "nm_proyek": "Platform Mengumpulkan Ide",
          "id_kategori": 1,
          "deskripsi": "ini adalah aplikasi mirip idekita hehe",
          "gambar": "https://storage.googleapis.com/project-img/3iribYxloRspFA-jNa-Mi.jpeg",
          "tanggal_mulai": "2023-05-23",
          "tanggal_selesai": "2023-08-24",
          "status": "berlangsung",
          "total_rate": 4,
          "jumlah_raters": 1,
          "mean_rate": 4,
          "contributors": [
              {
                  "id": 2,
                  "id_proyek": 2,
                  "username": "zul",
                  "role": "Beban",
                  "status_lamaran": "diterima"
              }
          ],
          "category": {
              "nm_kategori": "Sosial"
          }
      }
  ]
}

6. Update Project Status

URL:
- /proyek/:id_proyek
Method:
- PUT
Description:
- to change the project status
Header:
- Authorization: Bearer {token}
Parameters:
- id_proyek as int, required
Request Body:
- status as enum ['terbuka'(default), 'berlangsung', 'selesai'], required
- nm_proyek as string, optional
- deskripsi as string, optional
- tanggal_mulai as date, optional
- tanggal_selesai as date, optional
- file as file, optional, must be a valid image file, max size 2mb

Response:

  {
  "status": "success",
  "message": "Berhasil merubah status proyek"
  }

7. Delete Project

URL:
- /proyek/:id_proyek
Method:
- DELETE
Description:
- to delete a project
Header:
- Authorization: Bearer {token}
Parameters:
- id_proyek as int, required

Response:

  {
  "status": "success",
  "message": "Proyek berhasil dihapus"
  }

8. Search Project

URL:
- /proyek/cari/:string
Method:
- GET
Description:
- to get the project searched by project name
Header:
- Authorization: Bearer {token}

Parameters:

nm_proyek as string, required

{
  "status": "success",
  "message": "Daftar Project berhasil ditemukan",
  "projects": [
      {
          "id": 2,
          "creator": "deo",
          "nm_proyek": "Sistem Deteksi Hantu",
          "id_kategori": 2,
          "deskripsi": "ini deskripsi .... ya",
          "gambar": "https://storage.googleapis.com/project-img/lRIePPgY6DDGL1Vod4AEb.png",
          "tanggal_mulai": "2023-08-30",
          "tanggal_selesai": "2023-09-30",
          "status": "terbuka",
          "total_rate": 3,
          "jumlah_raters": 1,
          "mean_rate": 3,
          "postedAt": "2023-06-11",
          "category": {
              "nm_kategori": "Pendidikan"
          }
      }
  ]
}

Contribution Endpoint

back to top

1. Register Contribute

URL:
- /kontributor
Method:
- POST
Description:
- to register contribute
Header:
- Authorization: Bearer {token}
Request Body:
- id_proyek as int, required

Response:

{
  "status": "success",
  "message": "Kontributor Berhasil Mendaftar",
  "contributor": {
      "role": "-",
      "status_lamaran": "menunggu",
      "id": 7,
      "id_proyek": 1,
      "username": "user"
  }
}

2. Change/Update Contributor Status

URL:
- /kontributor/:id_kontributor
Method:
- PUT
Description:
- to change the contributor status to accepted or not by id, to update it must be the creator project
Header:
- Authorization: Bearer {token}
Parameters:
- id_kontributor as int, required
Request Body:
- status_lamaran as enum ['menunggu'(default), 'ditolak', 'diterima'], required
- role as string, optional

Response:

{
  "status": "success",
  "message": "Lamaran berhasil diterima!"
}

3. Get Contributors by Id Project

URL:
- /kontributor/:id_proyek
Method:
- GET
Description:
- to get contributor data on the project where status = diterima
Header:
- Authorization: Bearer {token}
Parameters:
- id_proyek as int, required

Response:

{
  "status": "success",
  "message": "Daftar Kontributor berhasil ditemukan",
  "contributors": [
      {
          "username": "zul",
          "name": "zul fiandi",
          "role": "Frontend Developer"
      },
      {
          "username": "user",
          "name": "User Baru",
          "role": "Backend Developer"
      }
  ]
}

4. Get Contributors Where Status Waiting

URL:
- /kontributor/menunggu/:id_proyek
Method:
- GET
Description:
- to get contributor data on the project where status = menunggu
Header:
- Authorization: Bearer {token}
Parameters:
- id_proyek as int, required

Response:

{
  "status": "success",
  "message": "Daftar Kontributor berhasil ditemukan",
  "contributors": [
      {
          "id": 3,
          "id_proyek": 3,
          "username": "deo",
          "role": "-",
          "status_lamaran": "menunggu"
      },
      {
          "id": 8,
          "id_proyek": 3,
          "username": "user",
          "role": "-",
          "status_lamaran": "menunggu"
      }
  ]
}

Rating Endpoint

back to top

1. Create Rating

URL:
- /rating
Method:
- POST
Description:
- to do a rating
Header:
- Authorization: Bearer {token}
Request Body:
- id_proyek as int, required
- password as int (1 - 5), required

Response:

{
  "status": "success",
  "message": "Berhasil melakukan rating",
  "rating": {
      "id": 7,
      "id_proyek": 2,
      "username": "user",
      "nilai": 4
  }
}

2. Update Rating

URL:
- /rating/:id_rating
Method:
- POST
Description:
- to update a rating
Header:
- Authorization: Bearer {token}
Parameters:
- id_rating as int, required
Request Body:
- id_proyek as int, required
- password as int (1 - 5), required

Response:

{
  "status": "success",
  "message": "Berhasil melakukan rating",
  "rating": {
      "id": 7,
      "id_proyek": 2,
      "username": "user",
      "nilai": 4
  }
}

Recommendation Endpoint

back to top

1. Get Recommendation

URL:
- /rekomendasi
Method:
- GET
Description:
- to show recommendation project
Header:
- Authorization: Bearer {token}

Response:

{
  "status": "success",
  "message": "Rekomendasi ditemukan",
  "recommendations": [
      {
          "id": 1,
          "id_user": 1,
          "id_project": 2,
          "project_title": "Sistem Deteksi Hantu",
          "user": {
              "id_user": 1,
              "username": "deo"
          },
          "project": {
              "id": 2,
              "creator": "deo",
              "nm_proyek": "Sistem Deteksi Hantu",
              "id_kategori": 2,
              "deskripsi": "ini deskripsi .... ya",
              "gambar": "https://storage.googleapis.com/project-img/lRIePPgY6DDGL1Vod4AEb.png",
              "tanggal_mulai": "2023-08-30",
              "tanggal_selesai": "2023-09-30",
              "status": "terbuka",
              "total_rate": 3,
              "jumlah_raters": 1,
              "mean_rate": 3,
              "postedAt": "2023-06-11",
              "category": {
                  "id": 2,
                  "nm_kategori": "Pendidikan"
              }
          }
      }
  ]
}

Room Chat Endpoint

back to top

1. Get Message

URL:
- /obrolan/:id_proyek
Method:
- GET
Description:
- to show room chat based on id project
Header:
- Authorization: Bearer {token}

Response:

{
  "status": "success",
  "messages": [
      {
          "messageId": "-NXxOlEb4i4Z2Q3KFvvT",
          "id_proyek": "57",
          "message": "halo gess",
          "username": "deo"
      },
      {
          "messageId": "-NXxRUwIlMoNXBooL7CX",
          "id_proyek": "57",
          "message": "p",
          "username": "deo"
      }
  ]
}

2. Post Message

URL:
- /obrolan/:id_proyek
Method:
- POST
Description:
- to show room chat based on id project
Header:
- Authorization: Bearer {token}
Request Body:
- message as string

Response:

{
  "status": "success",
  "message": "Pesan berhasil dikirim",
  "chatId": "-NXxRUwIlMoNXBooL7CX"
}

Installation

back to top

git clone https://github.com/idekita/cloud-computing.git
cd cloud-computing
npm install
npm run start-dev

Name		Name	Last commit message	Last commit date
Latest commit History 179 Commits
Postman_Files		Postman_Files
src		src
uploads		uploads
.dockerignore		.dockerignore
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
app.yaml		app.yaml
cloudbuild.yaml		cloudbuild.yaml
package-lock.json		package-lock.json
package.json		package.json

License

idekita/cloud-computing

Folders and files

Latest commit

History

Repository files navigation

Cloud Computing Documentation

List of Documentation

Tech Stack Used

Backend Stack

Cloud Stack

Here are the environment variables we created:

CI/CD Deployment

Database Relational

Endpoint URL

Auth and User Endpoint

1. Register

2. Login

3. Profil

Category Endpoint

1. Kategori

Project Endpoint

1. Create Project

2. Get All Projects

3. Detail Project

4. Get Project By Category

5. Get My Project Based on Status

6. Update Project Status

7. Delete Project

8. Search Project

Contribution Endpoint

1. Register Contribute

2. Change/Update Contributor Status

3. Get Contributors by Id Project

4. Get Contributors Where Status Waiting

Rating Endpoint

1. Create Rating

2. Update Rating

Recommendation Endpoint

1. Get Recommendation

Room Chat Endpoint

1. Get Message

2. Post Message

Installation

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 3

Uh oh!

Languages

Packages