diff --git a/.gitignore b/.gitignore index f2e01c6..d6a5902 100644 --- a/.gitignore +++ b/.gitignore @@ -75,4 +75,5 @@ lerna-debug.log* /supabase/config.toml /supabase/*.env /supabase/dev.env -/supabase/prod.env \ No newline at end of file +/supabase/prod.env +.vscode/settings.json diff --git a/README.md b/README.md index 159326f..e3ce64f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # LIFT Digital Workplace Passport -A digital workplace passport application that helps neurodivergent employees document and share their workplace needs with line managers, promoting a more inclusive workplace environment. +> A digital workplace passport application that helps neurodivergent employees document and share their workplace needs with line managers, promoting a more inclusive workplace environment. ## Technology Stack @@ -13,17 +13,20 @@ A digital workplace passport application that helps neurodivergent employees doc ## Development Setup 1. Clone the repository: + ```bash git clone https://github.com/foundersandcoders/LIFT02.git cd LIFT02 ``` 2. Install dependencies: + ```bash npm install ``` 3. Set up environment variables: + ```bash cp .env.example .env.local ``` @@ -31,6 +34,7 @@ A digital workplace passport application that helps neurodivergent employees doc Fill in the `.env.local` file with your Supabase project details. 4. Install Supabase CLI: + ```bash # Using npm npm install -g supabase @@ -42,11 +46,13 @@ A digital workplace passport application that helps neurodivergent employees doc For other installation options, see the [Supabase CLI docs](https://supabase.com/docs/guides/cli/getting-started). 5. Login to Supabase: + ```bash supabase login ``` 6. Link your local project to Supabase: + ```bash supabase link --project-ref ``` @@ -161,8 +167,8 @@ The project follows a standard SvelteKit structure: ## Documentation -For more detailed information, see: - - [FUNCTIONAL.md](./HITL_Docs/FUNCTIONAL.md) - Functional requirements - [ARCHITECTURE.md](./HITL_Docs/ARCHITECTURE.md) - Technical architecture -- [TESTING.md](./HITL_Docs/TESTING.md) - Testing guide \ No newline at end of file +- [TESTING.md](./HITL_Docs/TESTING.md) - Testing guide + +Explore this codebase on [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/foundersandcoders/LIFT02)