Merge pull request #58 from codex-team/chore/yarn3

chore: move from npm to yarn
codex-team · Oct 19, 2023 · 624b47d · 624b47d
2 parents 5feb875 + 984c32a
commit 624b47d
Show file tree

Hide file tree

Showing 9 changed files with 6,004 additions and 8,998 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,12 @@ dist
 dist-ssr
 *.local
 
+# package manager
+.yarn/*
+!.yarn/releases
+!.yarn/plugins
+.pnp.*
+
 # Editor directories and files
 .vscode/*
 !.vscode/extensions.json

diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v20
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,3 +1,8 @@
 {
-  "recommendations": ["vue.volar", "vue.vscode-typescript-vue-plugin"]
+  "recommendations": [
+    "vue.volar",
+    "vue.vscode-typescript-vue-plugin",
+    "arcanis.vscode-zipfs",
+    "dbaeumer.vscode-eslint"
+  ]
 }
diff --git a/.yarn/releases/yarn-3.6.4.cjs b/.yarn/releases/yarn-3.6.4.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,2 @@
+yarnPath: .yarn/releases/yarn-3.6.4.cjs
+nodeLinker: node-modules
diff --git a/README.md b/README.md
@@ -1 +1,26 @@
-# notes.web
+# notes.web
+
+### How to run the project
+
+Use node v20 (or at least v19)
+```
+nvm use
+```
+
+Install dependencies
+```
+yarn install
+```
+
+Copy .env.sample as .env
+```
+cp .env.sample .env
+```
+
+Run the project
+```
+yarn dev
+```
+
+The default project address is http://localhost:5173/
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		yarnPath: .yarn/releases/yarn-3.6.4.cjs
		nodeLinker: node-modules