Update README

purinx · Dec 11, 2023 · 4c495e8 · 4c495e8
1 parent 042a7c7
commit 4c495e8
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,2 @@
+NEXT_PUBLIC_SUPABASE_URL="..."
+SUPABASE_ADMIN_KEY="..."
diff --git a/README.md b/README.md
@@ -1,2 +1,49 @@
 # Neko-Auth
 
+Supabase and Next.js App Router Sample.
+
+## Requirement
+
+- Node.js v20
+- Supabase Account
+
+## Dependencies
+
+- Next.js (App Router)
+- supabase-js
+- pico.css
+- Jest
+- Storybook
+- Radix
+
+## Storybook
+
+```
+npm run storybook
+```
+
+## Test
+
+```
+cp .env.example .env.test.local
+# Edit .env.test.local
+npm run test
+```
+
+## Lint
+
+```
+npm run lint
+```
+
+## Run locally (for dev use)
+
+```
+cp .env.example .env.local
+# Edit .env.local
+npm run dev
+```
+
+## Deploy
+
+Push to main branch and it will be deployed by Vercel.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		NEXT_PUBLIC_SUPABASE_URL="..."
		SUPABASE_ADMIN_KEY="..."