diff --git a/README.md b/README.md index 5c4780a..79f001d 100644 --- a/README.md +++ b/README.md @@ -1,87 +1,64 @@ -# Welcome to React Router! +# Ristek Task Frontend -A modern, production-ready template for building full-stack React applications using React Router. +> **📄 Catatan Deployment:** Cara deployment menggunakan **Docker Compose** sudah disertakan di dalam **submisi PDF**. -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/remix-run/react-router-templates/tree/main/default) +--- -## Features +## Prasyarat -- 🚀 Server-side rendering -- ⚡️ Hot Module Replacement (HMR) -- 📦 Asset bundling and optimization -- 🔄 Data loading and mutations -- 🔒 TypeScript by default -- 🎉 TailwindCSS for styling -- 📖 [React Router docs](https://reactrouter.com/) +Pastikan sudah terinstall: -## Getting Started +- [Node.js 20+](https://nodejs.org/) (disarankan versi 24) +- npm -### Installation +--- -Install the dependencies: +## Cara Menjalankan Secara Lokal + +> **⚠️ Perhatian** Pastikan [applikasi backend](https://github.com/fossyy/ristek-task-be) sudah berjalan dan dapat di akses. + +### 1. Clone Repository + +```bash +git clone https://github.com/fossyy/ristek-task-fe +cd ristek-task-fe +``` + +### 2. Konfigurasi Environment + +Buat file `.env` di root project: + +```env +VITE_API_BASE_URL=http://localhost:8080 +``` + +### 3. Install Dependencies ```bash npm install ``` -### Development - -Start the development server with HMR: +### 4. Jalankan Aplikasi (Development) ```bash npm run dev ``` -Your application will be available at `http://localhost:5173`. +Aplikasi akan berjalan di `http://localhost:5173`. -## Building for Production - -Create a production build: +### 5. Build & Jalankan Production ```bash npm run build +npm run start ``` -## Deployment - -### Docker Deployment - -To build and run using Docker: - -```bash -docker build -t my-app . - -# Run the container -docker run -p 3000:3000 my-app -``` - -The containerized application can be deployed to any platform that supports Docker, including: - -- AWS ECS -- Google Cloud Run -- Azure Container Apps -- Digital Ocean App Platform -- Fly.io -- Railway - -### DIY Deployment - -If you're familiar with deploying Node applications, the built-in app server is production-ready. - -Make sure to deploy the output of `npm run build` - -``` -├── package.json -├── package-lock.json (or pnpm-lock.yaml, or bun.lockb) -├── build/ -│ ├── client/ # Static assets -│ └── server/ # Server-side code -``` - -## Styling - -This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer. +Aplikasi production berjalan di `http://localhost:3000`. --- -Built with ❤️ using React Router. +## Environment Variables + +| Variable | Wajib | Default | Keterangan | +| -------------------- | ----- | ------- | ------------------------------ | +| `VITE_API_BASE_URL` | ✅ | — | URL backend API |