Merge pull request #98 from fac29/update_readME

added supabase client on front and and update ReadMe

.github/workflows/deploy.yml

@@ -3,7 +3,7 @@ name: Deploy to GitHub Pages
 on:
   push:
     branches:
-      - deploy # branch to deploy from
+      - main # branch to deploy from
 
 jobs:
   build:

README.md

@@ -1,6 +1,17 @@
 # NISA Invest
 
-NISA Invest is a personal finance platform for Muslim women.
+
+
+## Table of contents
+
+1. [About](#about)
+2. [Tech Stack](#tech-stack)
+3. [Local Environment](#local-environment)
+4. [Hosting & deployment](#hosting--deployment)
+
+
+## About
+NISA Invest is a personal finance platform for Muslim women. It's main functions are to be able to book a call with a fincial advisor, a quiz which then leads you to a dashboard where you can click to see a personalised list of goals (widgets). Once you have completed this goal, you make it as complete and it moves to the top of the page. Once you have finished all your pre-populated priorities, you can choose more goals from the bottom section to be your new focus. 
 
 ## Tech Stack
 
@@ -9,9 +20,9 @@ This project uses the following technologies:
 - **Frontend Framework**: React
 - **Language**: TypeScript
 - **Build Tool**: Vite
-- **UI Styling**: Tailwind CSS
+- **UI Styling**: Tailwind and CSS
 
-## Getting Started
+## Local Environment
 
 1. Clone the repository:
 
@@ -55,6 +66,10 @@ VITE_BASE_URL = "https://nisa-invest-tfb-be.vercel.app"
 npm run dev
 ```
 
+
+
+## Hosting & deployment
+
 ## Style Guide
 
 Contributors should refer to our style guide for coding conventions and best practices. The style guide can be found at:

src/supabaseClient.ts

@@ -0,0 +1,10 @@
+import { createClient } from '@supabase/supabase-js'
+
+const supabaseUrl = import.meta.env.VITE_SUPABASE_URL
+const supabaseAnonKey = import.meta.env.VITE_SUPABASE_ANON_KEY
+
+if (!supabaseUrl || !supabaseAnonKey) {
+  console.error('Supabase URL or Key is missing. Check your environment variables.')
+}
+
+export const supabase = createClient(supabaseUrl, supabaseAnonKey)

vite.config.ts

@@ -22,3 +22,4 @@ export default defineConfig(({ mode }) => {
     },
   };
 });
+