Social Site

Sosyel

Git branching

Repository akan memiliki 2 branch utama, yaitu master dan production. Setiap pembuatan branch baru, buat branch baru dengan base master. Format: <tipe>/<judul>

List tipe:

• Story, untuk fitur atau use case baru
• Task, untuk bug fixing, performance improvement, refactor, dsb.

Judul: gunakan kebab case

Contoh:

• story/api-attendance
• story/page-attendance
• task/improve-sql-performance-on-xxxx-method

Setelah selesai, Pull Request ke master dan wajib minta peer review ke kadiv/wakadiv.

Code Styling & Repository

Sangat dimohon untuk memperhatikan hal-hal berikut:

1. Penamaan variabel, fungsi, dan kelas yang bermakna
2. Penyingkatan harus mudah ditebak dan masih terbaca
   • Misalkan, codeStylingAndRepository, terlalu panjang, disingkat menjadi: codeStyleNRepo
   • Yang Salah: csnr, cdStNrep
   • Membuat kelas dengan pascal case (ClassName)
3. Membuat fungsi dan variable dengan camel case (fungsiDanVariabel)
4. Membuat folder dengan snake case (folder_styling)
5. Membuat file dengan kebab case (file-styling.tsx)
6. Membuat komponen React dan nama filenya dengan pascal case (NamaKomponen)

Semantic Commit Message

• feat: (new feature for the user, not a new feature for build script)
• fix: (bug fix for the user, not a fix to a build script)
• docs: (changes to the documentation)
• style: (formatting, missing semi colons, etc; no production code change)
• refactor: (refactoring production code, eg. renaming a variable)
• test: (adding missing tests, refactoring tests; no production code change)
• chore: (updating grunt tasks etc; no production code change)

Full SOP can be found here: Developer's Guide

Local Development Setup

Sistem Operasi

Bila anda penggguna Windows, gunakan Ubuntu atau distro lain dengan WSL2. Selain itu, anda bisa menggunakan Linux distribusi apa pun atau Mac OS. Referensi instalasi WSL: https://learn.microsoft.com/en-us/windows/wsl/install

Git

Authorize ke github menggunakan SSH/ HTTPs. Referensi untuk SSH:

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account

Requirements

1. Node versi 18
2. Yarn
3. Redis
4. Postgres

Instalasi Requirements

1. Install node 18 melalui node version manager. Referensi: https://github.com/nvm-sh/nvm#installing-and-updating

nvm install lts/hydrogen

2. Install postgres, buat database baru (nama bebas). Referensi: https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-database#install-postgresql
3. Install Redis. Referensi: https://redis.io/docs/getting-started/installation/install-redis-on-windows/

Langkah-Langkah

1. Clone repo git clone git@github.com:KATITB2023/social.git atau git clone https://github.com/KATITB2023/social.git
2. Install Yarn npm install --global yarn
3. Jalankan yarn install
4. Copy file .env.example menjadi .env
5. Ubah nilai dari DATABASE_URL menjadi alamat database kalian
6. Hapus baris NEXT_PUBLIC_WS_URL="ws://localhost:3000"
7. Jalankan database migration. yarn migrate-dev
8. Jalankan local dev server. yarn dev