From 8eb51dd40658479d314b36b5d6ecfe43d48acce6 Mon Sep 17 00:00:00 2001 From: averel10 Date: Tue, 2 Jun 2026 09:05:07 +0200 Subject: [PATCH] feat: cleaned up some parts of readme --- README.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 36baed5..6d391ed 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ A Next.js web application for annotating and managing dialect audio datasets. - Node.js 18+ - npm or yarn -- SQLite (included with better-sqlite3) ## Quick Start @@ -16,11 +15,11 @@ npm install ``` ### 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 ```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 ``` @@ -34,12 +33,13 @@ Open [http://localhost:3000](http://localhost:3000) in your browser. - `src/app/` - Next.js pages and API routes - `admin/` - Admin dashboard pages + - `annotate/` - Annotation pages (actual application) - `user/` - User authentication pages + - `api/` - Different API-Pages for usage in frontend (Download, Upload, User) - `actions/` - Server actions for data operations - `src/components/` - Reusable React components - `src/lib/` - Utilities, database, and auth configuration -- `drizzle/` - Database migrations -- `public/datasets/` - Dataset storage +- `drizzle/` - Database migration files ## Available Scripts @@ -104,10 +104,4 @@ After successful upgrade: - The token becomes invalid - Your account gains full admin privileges - No new token is generated (admin now exists) -- 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/` \ No newline at end of file +- Trying to upgrade another account will fail (token is spent) \ No newline at end of file