Skip to content
Snippets Groups Projects
Commit 697f17d9 authored by GoDillonAudris512's avatar GoDillonAudris512
Browse files

chore: update README

parent f390be01
No related merge requests found
MYSQL_PASSWORD=
MYSQL_DATABASE=edujin-soap
MYSQL_PORT=3306
MYSQL_ROOT_PASSWORD=
APP_KEY=0c6d89de-0971-4e91-a38e-a95396a2507f
REST_KEY=4633ec57-a323-4ae3-8924-dd66895d8d2e
SMPTP_HOST=smtp-relay.brevo.com
SMPTP_PORT=587
SMPTP_USERNAME=
SMPTP_PASSWORD=
USE_DOCKER_CONFIG=true
PASSWORD_RESET_EXPIRE_HOURS = 0
PASSWORD_RESET_EXPIRE_MINUTES = 10
CONFIRMATION_EMAIL_EXPIRE_HOURS = 1
CONFIRMATION_EMAIL_EXPIRE_MINUTES = 0
SUBSCRIPTION_EXPIRE_HOURS = 0
SUBSCRIPTION_EXPIRE_MINUTES = 5
\ No newline at end of file
# Edujin_SOAP
> Dibuat untuk memenuhi Tugas Besar Milestone 2 IF3110 _Web Based Development_ - _Web Services using SOAP and REST_.
## Daftar Isi
- [Deskripsi _Web Service_](#deskripsi-web-service)
- [_Requirement_](#requirement)
- [Cara Instalasi](#cara-instalasi)
- [Cara Menjalankan _Server_](#cara-menjalankan-server)
- [Skema Basis Data](#skema-basis-data)
- [_Endpoint_ API](#endpoint-api)
- [Pembagian Tugas](#pembagian-tugas)
## Deskripsi _Web Service_
Edujin SOAP API merupakan sebuah layanan yang memungkinkan aplikasi Edujin untuk memanfaatkan fungsionalitas yang dimiliki oleh
sistem lain. Fungsionalitas ini berupa _email forget password_, layanan _subscribe_, dan artikel premium. SOAP _Service_ ini dikembangkan dengan memanfaatkan bahasa Java dengan kakas JAX-WS.
## _Requirement_
Untuk menjalankan layanan, diharapkan telah menginstall
- [Docker Engine](https://docs.docker.com/engine/install/)
## Cara Instalasi
1. _Clone repository_ ini dengan perintah
```bash
git clone https://gitlab.informatika.org/IF3110-2023-02-40/edujin-soap.git
```
atau dengan mengunduh _source code_ secara langsung.
2. Pastikan bahwa komputer Anda telah meng-_install_ dan menjalankan aplikasi Docker.
3. Buatlah sebuah file `.env` yang sesuai untuk penggunaan layanan (contoh dapat dilihat pada file `.env.example`)
## Cara Menjalankan _Server_
1. Jalankan _web service_ dengan menjalankan perintah berikut pada terminal.
```bash
docker compose up -d --build
```
2. _Web service_ dapat diakses dengan _browser_ pada URL `http://localhost:8082`.
3. _Web service_ dapat dihentikan dengan menjalankan perintah berikut pada terminal.
```bash
docker compose down
```
## Skema Basis Data
![SOAP Database](./assets/SOAP_Database.png)
## _Endpoint_ API
Berikut merupakan daftar _endpoint_ API yang disediakan oleh layanan Edujin SOAP:
- /reset: _Endpoint_ untuk melakukan _reset password_ akun pengguna.
- /subscribe: _Endpoint_ untuk melakukan _subscribe_ akun pengguna.
## Pembagian Tugas
| Layanan SOAP | NIM |
| ------------------------- | -------- |
| Fungsi Logging | 13521110 |
| Fungsi Subscription | 13521062 |
| Fungsi _Forget Password_ | 13521045 |
\ No newline at end of file
assets/SOAP_Database.png

96.8 KiB

0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment