https://github.com/boluwatife2904/yougamble-test

Chat application for yougamble test project
https://github.com/boluwatife2904/yougamble-test

Last synced: 9 days ago
JSON representation

Chat application for yougamble test project

• Host: GitHub
• URL: https://github.com/boluwatife2904/yougamble-test
• Owner: Boluwatife2904
• Created: 2024-08-08T11:36:28.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-08T22:54:36.000Z (3 months ago)
• Last Synced: 2024-08-10T01:41:19.456Z (3 months ago)
• Language: Vue
• Size: 697 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Project Brief

The aim of this project is to a build a simple real time chat application using Nuxt 3 and Supabase with real time capabilities.

The project is build using Nuxt 3.12 which is the latest Nuxt 3 version. Some of the project dependencies include

-   Supabase for backend

-   Nuxt UI/TailwindCSS for styling

-   Typescript for type safety

-   ESLint, Prettier for ensuring code quality and formatting

-   Dayjs for date formatting

-   Yup for form validations

## Setup

After cloning this repo, cd into the directory by running

```

cd chat

```

Then proceed to install the dependencies:

```bash

yarn install

```

Start the development server on `http://localhost:3000`:

```bash

yarn dev

```

### Setup supabase locally

You can follow this [guide](https://supabase.com/docs/guides/cli/local-development) to install supabase locally on your machine. Docker desktop is also required to run this

#### Setup database

Profiles: This image is a representation of the schema for user profiles

![Profiles Schema](readme-images/profiles-schema.png)

![Profiles RLS](readme-images/profiles-rls.png)

Messages: This image is a representation of the schema for messages table

![Messages Schema](readme-images/messages-schema.png)

![Messages RLS](readme-images/messages-rls.png)

#### Create functions and triggers

Create a new supabase function called `create_user_profile()`

```sql

BEGIN

insert into public.profiles(id, avatar_url, displayName)

values (new.id, '', new.raw_user_meta_data ->> 'displayName');

return new;

END;

```

Create a new supabase trigger using the SQL editor to create user profiles upon user registeration

```sql

CREATE TRIGGER create_user_profile

AFTER INSERT ON auth.users

FOR EACH ROW

EXECUTE FUNCTION create_user_profile();

```

#### Start Supabase server

```bash

supabase start

```

#### Add environment variables

A `.env.example` file is already added specifying what values need to run the project succesfully. The first two keys are gotten after running the `supabase start` command while the `BEARER_TOKEN` can be any value of choice which will be used when calling the `/api/users` endpoint to fetch all users.