https://github.com/dhanyn10/sun-alba
https://github.com/dhanyn10/sun-alba
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dhanyn10/sun-alba
- Owner: dhanyn10
- Created: 2022-10-17T05:13:44.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-20T14:11:20.000Z (over 2 years ago)
- Last Synced: 2025-01-16T23:26:12.965Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 83 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sun Alba [](https://github.com/dhanyn10/sun-alba/actions/workflows/docker.yml)
## Kebutuhan Sebelum Instalasi
Berikut ini aplikasi dan layanan yang perlu dimiliki sebelum menjalankan
aplikasi utama:
1. docker desktop
2. RajaOngkir API key, [daftar dulu](https://rajaongkir.com/akun/daftar) untuk mendapatkan API key
3. Salin isi file `.env.docker` ke dalam file `.env`
4. simpan API key yang didapatkan didalam file `.env` pada variable `RAJA_ONGKIR`
5. jalankan composer autoload agar nilai env `RAJA_ONGKIR` terbaca,
gunakan command `composer dump-autoload`
## Cara Instalasi dengan Docker
1. pastikan docker desktop terinstall di sistem dan sudah running
2. gunakan command `docker-compose up -d` untuk proses install aplikasi dalam docker
3. tunggu 10 detik atau lebih setelah proses install selesai, lalu gunakan command di bawah ini untuk menjalankan database migration
```sh
docker exec web php artisan migrate
```
4. setelah itu, gunakan command di bawah ini untuk menjalankan database seeding dengan data dummy
```sh
docker exec web php artisan db:seed
```
## Cara Penggunaan Aplikasi dengan Postman
### User Auth
1. **Get All User** kunjungi alamat `localhost:8000/users` dengan method `GET` untuk mendapatkan data email dummy. Data email ini nanti akan diperlukan untuk login ke dalam sistem.
2. **User Register** kunjungi alamat `localhost:8000/register` dengan method `POST` untuk register user baru. Pilih `Body > raw > JSON` dan isi data yang dibutuhkan seperti contoh di bawah ini:
```json
{
"name": "hello",
"email": "[email protected]",
"password": "hello_password"
}
```
jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "data created"
}
```
3. **User Login** Kunjungi alamat `localhost:8000/login` dengan method `POST` untuk login dengan email dan password yang telah terdaftar. Pilih `Body > raw > JSON` dan isi data yang dibutuhkan seperti contoh di bawah ini:
```json
{
"email": "[email protected]",
"password": "hello_password"
}
```
jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "logged in"
}
```
4. **User Logout** Kunjungi alamat `localhost:8000/logout` dengan method `POST` untuk logout dengan email dan password yang telah terdaftar. Pilih `Body > raw > JSON` dan isi data yang dibutuhkan seperti contoh di bawah ini:
```json
{
"email": "[email protected]",
"password": "hello_password"
}
```
jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "logged out"
}
```
### Categories
1. **Login** diperlukan sebelum bisa mengakses data categories. Silakan gunakan data dummy users yang sudah digenerate sebelumnya maupun yang sudah dibuat sendiri. Data dummy user bisa digunakan untuk login dengan menggunakan akun email manapun yang terdaftar di sistem. Sementara itu, untuk password seluruh data dummy adalah `password`.
2. **Get Categories** untuk menayangkan seluruh data kategori. Kunjungi alamat `localhost:8000/categories` dengan method `GET`
3. **Post Categories** untuk menambah data kategori. Kunjungi alamat `localhost:8000/categories` dengan method `POST`. Pilih `Body > raw > JSON` dan isi data yang dibutuhkan seperti contoh di bawah ini:
```json
{
"name": "Valentino Rossi"
}
```
jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "category created"
}
```
4. **Put Categories** untuk mengubah/update data kategori berdasarkan id-nya. Kunjungi alamat `localhost:8000/categories/11` untuk mengupdate kategori dengan id `11` dengan method `PUT`. Pilih `Body > raw > JSON` dan isi data yang dibutuhkan seperti contoh di bawah ini:
```json
{
"name": "Lionel Messi"
}
```
jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "category updated"
}
```
5. **Delete Categories** untuk menghapus kategori berdasarkan id-nya. Kunjungi alamat `localhost:8000/categories/11` untuk menghapus kategori dengan id `11` dengan method `DELETE`. Jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "category deleted"
}
```
### Tags
1. **Login** diperlukan sebelum bisa mengakses data tags. Silakan gunakan data dummy users yang sudah digenerate sebelumnya maupun yang sudah dibuat sendiri. Ddata dummy user bisa digunakan untuk login dengan menggunakan akun email manapun yang terdaftar di sistem.
Sementara itu, untuk password seluruh data dummy adalah `password`.
2. **Get Tags** untuk menayangkan seluruh data tag. Kunjungi alamat `localhost:8000/tags` dengan method `GET`
3. **Post Tags** untuk menambah data tag. Kunjungi alamat `localhost:8000/tags` dengan method `POST`. Pilih `Body > raw > JSON` dan isi data yang dibutuhkan seperti contoh di bawah ini:
```json
{
"name": "tag_abc"
}
```
jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "tag created"
}
```
4. **Put Tags** untuk mengubah/update data tag berdasarkan id-nya. Kunjungi alamat `localhost:8000/tags/2` untuk mengupdate tag dengan id `2` dengan method `PUT`. Pilih `Body > raw > JSON` dan isi data yang dibutuhkan seperti contoh di bawah ini:
```json
{
"name": "tag_bcd"
}
```
jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "tag updated"
}
```
5. **Delete Tags** untuk menghapus tag berdasarkan id-nya. Kunjungi alamat `localhost:8000/tags/6` untuk menghapus tag dengan id `6` dengan method `DELETE`. Jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "tag deleted"
}
```
### Posting
1. **Login** diperlukan sebelum bisa mengakses data Blog Posting. Silakan gunakan data dummy users yang sudah digenerate sebelumnya maupun yang sudah dibuat sendiri. Data dummy user bisa digunakan untuk login dengan menggunakan akun email manapun yang terdaftar di sistem.
Sementara itu, untuk password seluruh data dummy adalah `password`.
2. **Get Posting** untuk menayangkan seluruh data posting . Kunjungi alamat `localhost:8000/posts` dengan method `GET`
3. **Post Posting** untuk menambah data posting. Kunjungi alamat `localhost:8000/posts` dengan method `POST`. Pilih `Body > raw > JSON` dan isi data yang dibutuhkan seperti contoh di bawah ini:
```json
{
"title": "Indonesia Merdeka",
"content": "proklamasi 17 agustus 1945",
"categories": "[8,2,1,4]",
"tags": "[4,5]"
}
```
Pastikan sebelumnya bahwa id categories dengan nilai 8, 2, 1, dan 4 telah ada di dalam database, dan id tags dengan nilai 4 dan 5 juga terdaftar di database agar bisa menambahkan posting baru.
jika penambahan posting berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "post created"
}
```
4. **Put Posting** untuk mengubah/update data posting berdasarkan id-nya. Kunjungi alamat `localhost:8000/posts/6` untuk mengupdate posting dengan id `6` dengan method `PUT`. Pilih `Body > raw > JSON` dan isi data yang dibutuhkan seperti contoh di bawah ini:
```json
{
"title": "Indonesia Merdeka",
"content": "Bandung Lautan API, ayo rebut kembali",
"categories": "[8,2,1,3]",
"tags": "[4,2]"
}
```
jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "post updated"
}
```
5. **Delete Posting** untuk menghapus posting berdasarkan id-nya. Kunjungi alamat `localhost:8000/posts/6` untuk menghapus kategori dengan id `6` dengan method `DELETE`. Jika berhasil, maka akan mendapatkan response seperti di bawah ini:
```json
{
"message": "post deleted"
}
```
6. **View Blog Post** untuk melihat posting dengan blog view. Kunjungi `http://localhost:8000` pada browser untuk melihatnya.
### Shipping
1. **Login** diperlukan sebelum bisa mengakses API Shipping. Silakan gunakan data dummy users yang sudah digenerate sebelumnya maupun yang sudah dibuat sendiri. Data dummy user bisa digunakan untuk login dengan menggunakan akun email manapun yang terdaftar di sistem. **Mulai dari sini, Akan menggunakan API RAJA ONGKIR**. Jadi, pastikan sudah menjalankan instruksi mengenai RAJA_ONGKIR.
Sementara itu, untuk password seluruh data dummy adalah `password`.
2. **Get Province** untuk menayangkan seluruh data provinsi . Kunjungi alamat `localhost:8000/shipping/province` dengan method `GET`
3. **Get City** untuk menayangkan seluruh data Kota berdasarkan provinsi dengan **id=1** . Kunjungi alamat `localhost:8000/shipping/city/1` dengan method `GET`
4. **Costs** untuk mendapatkan data shipping cost. Contohnya ingin memperoleh shipping cost dengan pengiriman dari `city_id: 17` ke `city_id:32` dengan nilai berat `10`, maka kunjungi alamat `localhost:8000/shipping/costs` dengan method `POST`, pilih `Body > raw > JSON` lalu isi dengan json di bawah ini:
```json
{
"origin": 17,
"destination": 32,
"weight": 10
}
```