Skip to content

Commit

Permalink
add documentation for naming convetions
Browse files Browse the repository at this point in the history
  • Loading branch information
mmvergara committed Aug 21, 2024
1 parent c9d6cbc commit c663299
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,20 @@ dart pub add intl

> Unless you are not using any date types, you can skip this step
#### 1.4 Use snake casing for table names and column names (Optional)

this tool will automatically convert snake_case to camelCase for both table (ClassName) and column (FieldName).

```
snake_case => camelCase
user_table => UserTable
```

```
snake_case => camelCase
user_id => userId
```

## 2. Generate Dart Classes

### Using the [Web App](https://supadart.vercel.app/)
Expand Down Expand Up @@ -187,8 +201,6 @@ supadart -u <your-supabase-url> -k <your-supabase-anon-key>
Assuming the following table schema <br/>
> we recommend using **snake_casing** for your table names, as it will be converted to **PamelCasing** in the generated classes.
```sql
create table
public.books (
Expand Down

0 comments on commit c663299

Please sign in to comment.