Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,5 @@ lerna-debug.log*
/supabase/config.toml
/supabase/*.env
/supabase/dev.env
/supabase/prod.env
/supabase/prod.env
.vscode/settings.json
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -13,24 +13,28 @@ 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
```

Fill in the `.env.local` file with your Supabase project details.

4. Install Supabase CLI:

```bash
# Using npm
npm install -g supabase
Expand All @@ -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 <your-project-reference>
```
Expand Down Expand Up @@ -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
- [TESTING.md](./HITL_Docs/TESTING.md) - Testing guide

Explore this codebase on [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/foundersandcoders/LIFT02)