update frontend readme.md

README.md

@@ -1,4 +1,9 @@
-# An easy to use whiteboard
+# Infinity
+
+## Get started
+
+* bankend
+* frontend
 
 ## 控制画线平滑的算法
 

frontend/README.md

@@ -1 +1,40 @@
-This is a starter template for [Learn Next.js](https://nextjs.org/learn).
+# Frontend
+
+## Run locally
+
+* Prerequisites
+
+1. Node v18.15.0+
+2. git
+
+```bash
+$ cd ~/vswork
+$ git clone git@github.com:huoyijie/infinity.git
+```
+
+* Install deps
+
+```bash
+$ cd infinity/frontend
+$ npm i
+```
+
+* Add .env file
+
+```bash
+$ cat <<EOF > .env
+NEXT_PUBLIC_SOCKETIO_URL=ws://your_bankend_server_domain_or_ip:your_bankend_server_port
+EOF
+```
+
+Don't forget to change `your_bankend_server_domain_or_ip` and `your_bankend_server_port` (5000).
+
+If you run the bankend server behind reverse server (such as Nginx) and use tls, change `ws` to `wss`. 
+
+* Run server
+
+```bash
+$ npm run dev
+```
+
+## Deploy steps [Github pages]