React BOILERPLATE

Ini adalah Boilerplate React dengan dependencies

• React
• React Router (Latest)
• Racoil (State Management)
• Vite (Web Bundler)
• Vitest (Unit Testing based on Vite)
• UnoCSS (Successor of TailwindCSS and WindiCSS)
• ESLint
• Prettier
• Nix Flake (Development Dependencies Manager)
• Nix Direnv (Automate Development Dependencies)
• Docker (Containerizer)
• Nginx (Web Server)
• Axios
• Husky

Initial Setup

• Clone Project ini ( Direkomendasikan menggunakan SSH )

git clone git@github.com:maulanasdqn/react-boilerplate

Install NodeJS dan Yarn

• Anda perlu menginstall dulu NodeJS dan Yarn ( Direkomendasikan menggunakan NodeJS Versi 16 )

npm i -g yarn

Install Dependency

• Pasang Dependency

yarn install

Development With Nix

Development dengan Nix membuat proses Develop menjadi lebih mudah dan ringkas dengan ada nya Flake.nix semua dependency akan terurus dengan sendirinya dan juga independent artinya tidak akan menggangu environment yang lain

• Pasang Nixpkgs

sh <(curl -L https://nixos.org/nix/install) --no-daemon

• Pasang nix-flakes

nix-env -iA nixpkgs.nixFlakes

• Setup nix-flakes
  Edit file yang ada di ~/.config/nix/nix.conf atau /etc/nix/nix.conf dan tambahkan:

experimental-features = nix-command flakes

• Pasang nix-direnv

nix-env -f '<nixpkgs>' -iA nix-direnv

• Setup nix-direnv

source $HOME/.nix-profile/share/nix-direnv/direnvrc

• Masuk ke folder yang sudah di clone kemudian jalankan perintah berikut

direnv allow

• Dan enjoy tinggal tunggu dependency terinstall dengan sendirinya

Development with Docker

Docker harus di pasang dulu jika belum ada

• Pasang Docker bisa di unduh di https://docker.com

• Setup Docker

docker compose up

Setup Env

ENV di sesuaikan seperti yang ada di contoh .env.example

• Rename file .env.example menjadi .env.local
• Isi ENV sesuai dengan yang ada di dalam file .env.local nya

Setup Husky

Untuk bisa menggunakan husky agar berjalan baik dan benar maka perlu di inisialisasi dulu

• Jalankan perintah

  npx husky-init

Running Test, Formatter and Linter

Jika anda mau menjalankan Unit test, format semua dokumen dan menjalankan linting

• Jalnkan perintah ini untuk test sekali jalan

yarn test:run

• Jalankan perintah ini untuk test dengan watch mode

yarn test

• Jalankan perintah ini untuk test dengan coverage mode

yarn test:coverage

• Jalankan perintah ini untuk format seluruh dokumen

yarn format

• Jalankan perintah ini untuk linting dokumen tanpa fix

yarn lint

• Jalankan perintah ini untuk lintind dokumen dengan fix

yarn lint:fix

Deployment Guide

• Netlify dan Vercel Jika anda bermaksud untuk mendeploy nya ke netlify atau vercel anda hanya perlu membinding repository ini ke branch main untuk production dan ke branch dev untuk development

• Vps atau Heroku Jika anda bermaksud untuk mendeploy nya ke vps atau heroku anda bisa menggunakan docker container untuk deployment nya karena sudah terintegrasi baik dengan nginx