Fakultas Ilmu Komputer UI

Update README.md

parent b3cdc8d2
......@@ -49,12 +49,28 @@ Sudah ready untuk dijalankan di production? Mohon [lihat deployment guide beriku
5. Jalankan command ```docker-compose down``` untuk menghentikan server
## Notes
1. System hanya membolehkan user dengan role admin untuk membuat topic. User akan otomatis mendapat role reguler saat login pertama kali ke aplikasi ini. Untuk mengganti role, mantainer app ini harap mengganti role langaung di dalam database.
2. SECRET_KEY_BASE di generate dengan perintah ```mix phx.gen.secret```. GUARDIAN_SECRET_KEY_BASE dapat di generate dengan perintah ```mix guardian.gen.secret```. (Pengguna harus menginstall dependencies terlebih dahulu dengan ```mix deps.get```)
## Aturan Migrations
Migrations pada framework phoenix menggunakan library [Ecto](https://hexdocs.pm/ecto/Ecto.html). Migrations ini hampir mirip dengan dengan salah satu library node.js, yaitu ```sequelize```.
Aturan:
1. Untuk Membuat table database baru, phoenix framework menyediakan generator model, views, dan template dengan views sederhana untuk melakukan CRUD pada table database tersebut dengan command ```mix phx.gen.json```. Untuk eksplor lebih dalam dapat melihat [link berikut](https://hexdocs.pm/phoenix/Mix.Tasks.Phx.Gen.Json.html).
2. Jika table sudah terbentuk dan kontributor ingin memodifkasi table tersebut, kontributor diharuskan membuat file migrations untuk memodifikasi hal tersebut secara manual. Untuk mengenerate file migrations tersebut dapat menggunakan command ```mix ecto.gen.migration nama-file-migrations```.
## Cara Kontribusi
1. Fork Pada repository ini.
2. Clone pada repository hasil fork pada tahap 1.
3. Set git remote upstream dengan repository original dengan command ```git remote add upstream https://gitlab.cs.ui.ac.id/functional-programming/diskuy-backend.git``` (https) atau ```git remote add upstream git@gitlab.cs.ui.ac.id:functional-programming/diskuy-backend.git``` (ssh)
4. Buatlah branch baru pada repository fork dengan penamaan branch ```feature/nama-feature```
5. Jika fitur tersebut ingin disubmit / merge ke repo upstream, push branch fitur tersebut dan lakukan merge request ke branch master. Set reviewer merge request tersebut dengan owner dari repository ini.
## Pelajari lebih lanjut
* Official website: https://www.phoenixframework.org/
......
Markdown is supported
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