feat: cleaned up some parts of readme

This commit is contained in:
averel10
2026-06-02 09:05:07 +02:00
parent 53da7fa8b0
commit 8eb51dd406

View File

@@ -6,7 +6,6 @@ A Next.js web application for annotating and managing dialect audio datasets.
- Node.js 18+ - Node.js 18+
- npm or yarn - npm or yarn
- SQLite (included with better-sqlite3)
## Quick Start ## Quick Start
@@ -16,11 +15,11 @@ npm install
``` ```
### 2. Set Up Environment Variables ### 2. Set Up Environment Variables
Create a `.env` file in the project root with necessary configuration (database URL, auth secrets, etc.). Create a `.env` file in the project root with necessary configuration based on `.env.example`.
### 3. Initialize Database ### 3. Initialize Database
```bash ```bash
npm run db:generate # Generate migration files npm run db:generate # Generate migration files (if changes were made to the db)
npm run db:push # Apply migrations to database npm run db:push # Apply migrations to database
``` ```
@@ -34,12 +33,13 @@ Open [http://localhost:3000](http://localhost:3000) in your browser.
- `src/app/` - Next.js pages and API routes - `src/app/` - Next.js pages and API routes
- `admin/` - Admin dashboard pages - `admin/` - Admin dashboard pages
- `annotate/` - Annotation pages (actual application)
- `user/` - User authentication pages - `user/` - User authentication pages
- `api/` - Different API-Pages for usage in frontend (Download, Upload, User)
- `actions/` - Server actions for data operations - `actions/` - Server actions for data operations
- `src/components/` - Reusable React components - `src/components/` - Reusable React components
- `src/lib/` - Utilities, database, and auth configuration - `src/lib/` - Utilities, database, and auth configuration
- `drizzle/` - Database migrations - `drizzle/` - Database migration files
- `public/datasets/` - Dataset storage
## Available Scripts ## Available Scripts
@@ -105,9 +105,3 @@ After successful upgrade:
- Your account gains full admin privileges - Your account gains full admin privileges
- No new token is generated (admin now exists) - No new token is generated (admin now exists)
- Trying to upgrade another account will fail (token is spent) - Trying to upgrade another account will fail (token is spent)
## Development Notes
- Database schema is defined in `src/lib/model/`
- Authentication config is in `src/lib/auth.ts`
- Server actions for database operations are in `src/app/actions/`