docs: add deploy part to readme

sparcs-kaist · Apr 26, 2024 · 73cb62b · 73cb62b
1 parent 8243869
commit 73cb62b
Showing 1 changed file with 8 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -7,21 +7,13 @@ Currently, two official plugins are available:
 - [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
 - [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
 
-## Expanding the ESLint configuration
+## Deploy
+**Prerequisites**
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+1. Need a zabo-boards package in sparcs-kaist organization.
+2. Need to login to sparcs-kaist using Github Token and Github CLI.
 
-- Configure the top-level `parserOptions` property like this:
-
-```js
-   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-   },
-```
-
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+**Procedure**
+1. Run `git clone https://github.com/sparcs-kaist/zabo-boards.git`
+2. Run `docker compose -p zabo-boards -f .docker/docker-compose.yaml up`
+3. After Step 2, watch-tower will automatically pull latest zabo-boards package and redeploy.