Skip to content

Commit 6223c1e

Browse files
committed
doc: Adds user role functionality
Extends user creation with roles and defaults to "user". Updates database schema and CLI command documentation. Provides example for creating an admin user.
1 parent f8ac783 commit 6223c1e

7 files changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ npx nuxt-users migrate
3636

3737
# Create your first user
3838
npx nuxt-users create-user user@example.com "John Doe" password123
39+
# Create an admin user
40+
npx nuxt-users create-user admin@example.com "Admin User" adminpass123 admin
3941
```
4042

4143
## Documentation

docs/api/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Authenticate a user with email and password.
2525
"id": 1,
2626
"email": "user@example.com",
2727
"name": "John Doe",
28+
"role": "user",
2829
"created_at": "2024-01-01T00:00:00.000Z",
2930
"updated_at": "2024-01-01T00:00:00.000Z"
3031
}

docs/contributing/code-style.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ interface User {
2121
email: string
2222
name: string
2323
password: string
24+
role: string
2425
created_at: string
2526
updated_at: string
2627
}

docs/database/cli-commands.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,19 @@ npx nuxt-users create-password-reset-tokens-table
5656
#### Create a New User
5757

5858
```bash
59-
npx nuxt-users create-user <email> <name> <password>
59+
npx nuxt-users create-user <email> <name> <password> [role]
6060
```
6161

6262
**Arguments:**
6363
- `email`: User's email address (required)
6464
- `name`: User's full name (required)
6565
- `password`: User's password (required)
66+
- `role`: User's role (optional, defaults to "user")
6667

6768
**Example:**
6869
```bash
6970
npx nuxt-users create-user john@example.com "John Doe" mypassword123
71+
npx nuxt-users create-user admin@example.com "Admin User" adminpass123 admin
7072
```
7173

7274
### `project-info`

docs/database/schema.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ CREATE TABLE users (
1919
email TEXT NOT NULL UNIQUE,
2020
name TEXT NOT NULL,
2121
password TEXT NOT NULL,
22+
role TEXT NOT NULL DEFAULT 'user',
2223
created_at DATETIME DEFAULT CURRENT_TIMESTAMP,
2324
updated_at DATETIME DEFAULT CURRENT_TIMESTAMP
2425
);
@@ -58,6 +59,7 @@ CREATE TABLE users (
5859
email VARCHAR(255) NOT NULL UNIQUE,
5960
name VARCHAR(255) NOT NULL,
6061
password VARCHAR(255) NOT NULL,
62+
role VARCHAR(32) NOT NULL DEFAULT 'user',
6163
created_at DATETIME DEFAULT CURRENT_TIMESTAMP,
6264
updated_at DATETIME DEFAULT CURRENT_TIMESTAMP
6365
);
@@ -97,6 +99,7 @@ CREATE TABLE users (
9799
email VARCHAR(255) NOT NULL UNIQUE,
98100
name VARCHAR(255) NOT NULL,
99101
password VARCHAR(255) NOT NULL,
102+
role VARCHAR(32) NOT NULL DEFAULT 'user',
100103
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
101104
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
102105
);
@@ -150,6 +153,7 @@ Stores user account information.
150153
| `email` | TEXT/VARCHAR(255) | User's email address (unique) |
151154
| `name` | TEXT/VARCHAR(255) | User's display name |
152155
| `password` | TEXT/VARCHAR(255) | Hashed password (bcrypt) |
156+
| `role` | TEXT/VARCHAR(32) | User role (defaults to 'user') |
153157
| `created_at` | DATETIME | Account creation timestamp |
154158
| `updated_at` | DATETIME | Last update timestamp |
155159

docs/get-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ npx nuxt-users migrate
3737

3838
# Create your first user
3939
npx nuxt-users create-user user@example.com "John Doe" password123
40+
# Create an admin user
41+
npx nuxt-users create-user admin@example.com "Admin User" adminpass123 admin
4042
```
4143

4244
## What's Included

docs/guide/quick-start.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ npx nuxt-users migrate
3434

3535
# Create your first user
3636
npx nuxt-users create-user user@example.com "John Doe" password123
37+
# Create an admin user
38+
npx nuxt-users create-user admin@example.com "Admin User" adminpass123 admin
3739
```
3840

3941
## 4. Add Login Form to Your App

0 commit comments

Comments
 (0)