docs(README): update README to enhance installation and setup instructions

README.md

@@ -1,9 +1,75 @@
+# Compareware
+
+A modern web application for comparing items and their properties, built with Next.js and Prisma.
+
+## What is Compareware?
+
+Compareware allows users to compare different items by their properties in a structured, easy-to-use interface. Users can:
+
+- Add items for comparison via URLs
+- Select relevant properties for comparison
+- View side-by-side comparisons of items
+- Manage and customize comparison criteria
+
+## Tech Stack
+
+- **Frontend**: Next.js 15 with TypeScript
+- **Database**: SQLite with Prisma ORM
+- **Styling**: Tailwind CSS
+- **Runtime**: Node.js
 
 ## Getting Started
 
-First, run the development server:
+### Prerequisites
 
-```bash
+- Node.js 18+ 
+- npm, yarn, pnpm, or bun
+
+### Installation
+
+1. Clone the repository:
+```
+git clone git@forge.ftt.gmbh:ryanmwangi/Compareware_next.js.git
+cd compareware-nextjs
+```
+
+Install dependencies:
+
+```
+npm install
+# or
+yarn install
+# or
+pnpm install
+```
+
+
+# Set up the database:
+
+Generate Prisma client
+```
+npx prisma generate
+
+```
+
+Create and migrate the database
+```
+npx prisma migrate dev
+```
+or if you don't have migrations set up:
+
+```
+npx prisma db push
+```
+
+(Optional) Seed the database with initial data:
+```
+npx prisma db seed
+```
+
+
+Running the Development Server
+```
 npm run dev
 # or
 yarn dev
@@ -13,23 +79,5 @@ pnpm dev
 bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+Open http://localhost:3000 with your browser to see the application.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
-
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
-
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.