Skip to content

Commit 820b7c1

Browse files
committed
chore(global): Update README
1 parent 4805161 commit 820b7c1

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
11
# Full Stack Application Template
22

3-
A modern full-stack web application template built with Python/Litestar backend and Nuxt 4/Vue 3 frontend, featuring role-based access control with granular permissions.
3+
A modern full-stack web application template built with [Litestar](https://litestar.dev/) backend and [Nuxt](https://nuxt.com/) frontend.
4+
5+
## What's Included
6+
7+
A complete authentication and authorization system with:
8+
9+
- **User Management**: Full CRUD for users with role assignment
10+
- **Role & Permission System**: Granular resource-level permissions (e.g., `users:create`, `roles:read`)
11+
- **Admin Dashboard**: Pre-built UI for managing users, roles, and permissions
412

513
## Quick Start
614

715
### Prerequisites
8-
- **Backend**: Python 3.13+, [uv](https://docs.astral.sh/uv/), [just](https://github.com/casey/just)
9-
- **Frontend**: Node.js 18+, [bun](https://bun.sh/)
16+
- **Backend**: [uv](https://docs.astral.sh/uv/), [just](https://github.com/casey/just)
17+
- **Frontend**: [bun](https://bun.sh/)
1018
- **Database**: PostgreSQL
1119

1220
### Development Setup
1321

1422
```bash
1523
# Clone the repository
16-
git clone <repository-url>
17-
cd <project-directory>
24+
git clone https://github.com/dialvarezs/listestar-nuxt-fullstack
25+
cd listestar-nuxt-fullstack
1826

1927
# Backend setup
2028
cd app_api

0 commit comments

Comments
 (0)