Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 2.57 KB

README.md

File metadata and controls

93 lines (61 loc) · 2.57 KB
Raw

NISA Invest

Table of contents

  1. About
  2. Tech Stack
  3. Local Environment
  4. 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.

Here is the link to the deployed app. https://github.com/fac29/NisaInvest-TFB-FE/actions/runs/10410426533 When you click on this link you will see an empty dashboard. Please click on the Home button on the NavBar to see the completed dashboard. Screenshot 2024-08-29 at 14 00 17

Tech Stack

This project uses the following technologies:

  • Frontend Framework: React
  • Language: TypeScript
  • Build Tool: Vite
  • UI Styling: Tailwind and CSS

Local Environment

  1. Clone the repository:
git clone https://github.com/fac29/NisaInvest-TFB-FE.git
  1. Navigate to the repository:
cd NISAINVEST-TFB-FE
  1. Install NPM packages:
npm install
  1. Create .env files :
 touch .env.development
 touch .env.production

and include the following lines:

  • development:
VITE_BASE_URL=https://nisa-invest-tfb-be.vercel.app
VITE_SUPABASE_URL=http://localhost:54321
VITE_SUPABASE_ANON_KEY=[Check this at Supabase Online Dashboard]
VITE_SUPABASE_SERVICE_ROLE_KEY=[Check this at Supabase Online Dashboard]
  • production:
VITE_BASE_URL=https://nisa-invest-tfb-be.vercel.app
VITE_SUPABASE_URL=https://xzzacivebczssoporkmz.supabase.co
VITE_SUPABASE_ANON_KEY=[Check this at Supabase Online Dashboard]
VITE_SUPABASE_SERVICE_ROLE_KEY=[Check this at Supabase Online Dashboard]

Supabase references are needed for auth purposes. Fetching data from supabase is done exclusively from the back-end

  1. Enter the following script to run the server in the development mode:
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:

./docs/STYLEGUIDE.md

Please make sure to read and follow the style guide before submitting any pull requests.

#Force redeploy