Merge pull request #53 from FrostCord/FROS-Readme-And-Local-Dev-Instructions

Add localdev instrcts

Author: multimokia

.env.example

@@ -1,10 +1,9 @@
-
-NEXT_PUBLIC_SUPABASE_URL=YOUR_SUPABASE_URL
-NEXT_PUBLIC_SUPABASE_ANON_KEY=YOUR_SUPABASE_ANON_KEY
-PROJECT_ID=SUPABASE_REFERENCE_ID
+NEXT_PUBLIC_SUPABASE_URL=http://localhost:54321
+NEXT_PUBLIC_SUPABASE_ANON_KEY=<YOUR ANON KEY HERE>
+PROJECT_ID=<YOUR PROJECT ID HERE>
 
 LK_API_KEY=devkey
 LK_API_SECRET=secret
 
-NEXT_PUBLIC_LK_TOKEN_ENDPOINT=PATH_TO_TOKEN_GENERATOR
-NEXT_PUBLIC_LK_SERVER_URL=URL_TO_LIVEKITSERVER
+NEXT_PUBLIC_LK_TOKEN_ENDPOINT=/api/v1/auth/livekit
+NEXT_PUBLIC_LK_SERVER_URL=ws://localhost:7880

README.md

@@ -1,18 +1,54 @@
-## Getting Started
+## Getting Started With Local Development
+1. Clone this repository
+  ```bash
+  # HTTPS
+  $ git clone https://github.com/FrostCord/FrostCord.git
+
+  # or
+
+  # SSH
+  $ git clone git@github.com:FrostCord/FrostCord
+  ```
+2. Navigate to the project directory
+  ```bash
+  cd FrostCord
+  ```
+3. Head to https://app.supabase.com and sign up
+4. Create a new project and navigate to the settings/api tab
+5. Copy your project anon key and project reference id (the string of characters in the subdomain of supabase.co)
+6. Open `.env.example` and set:
+  - `NEXT_PUBLIC_SUPABASE_ANON_KEY` to the anon key you just copied
+  - `PROJECT_ID` to the project reference id from the previous step
+7. Rename `.env.example` to `.env.local`
+8. Install dependencies
+  ```bash
+  npm install
+  ```
+9. Prepare the local supabase containers
+  ```bash
+  npx supabase start
+  ```
+10. Install the livekit server by following instructions [here](https://docs.livekit.io/getting-started/server-setup/)
+  - If you're on Linux or Mac, you'll be ready to move onto the next step
+  - But if you're on windows, you'll want to make sure that the executable is somewhere that's on your system PATH
+11. Run livekit in dev mode
+  ```bash
+  # linux/mac
+  livekit-server --dev
+
+  # or for windows users
+  livekit-server.exe --dev
+  ```
+  - If you're on windows and get an error mentioning `bind: An attempt was made to access a socket in a way forbidden by its access permissions.`, you'll want to disable winnat using `net stop winnat` in your terminal. You can restart winnat again after using `net start winnat`
+12. Navigate to http://localhost:54323/project/default/storage/buckets and create 2 public buckets:
+  - avatars
+  - servericons
+13. Start NextJS dev server
+  ```bash
+  npm run dev
+  ```
+14. Navigate http://localhost:3000 and sign up/log in
 
-First, run the development server:
-
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-```
-
-Rename the `.env.example` to `.env.local` and fill in the variables
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
 You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
 

package.json

@@ -64,7 +64,7 @@
     "autoprefixer": "^10.4.13",
     "eslint": "^8.32.0",
     "postcss": "^8.4.21",
-    "supabase": "^1.38.7",
+    "supabase": "^1.45.2",
     "tailwindcss": "^3.2.4",
     "typescript": "^4.9.4"
   }