From ac44ddd1c307f023e336851197ffe6020715afa1 Mon Sep 17 00:00:00 2001
From: Kiran Surendran Pankan <kiranspankan@gmail.com>
Date: Sun, 30 Mar 2025 17:25:35 +0530
Subject: [PATCH] readme

---
 README.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 78 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 1511959..49960d5 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,80 @@
-# Vue 3 + Vite
+# Job Board Application
 
-This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+A modern job board application built with Vue 3 and Vite, featuring a clean and responsive design with dark mode support.
 
-Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).
+## Features
+
+- **Job Listings**: Browse through a curated list of job opportunities
+- **Job Details**: View comprehensive information about each job posting
+- **Job Tags**: Filter and categorize jobs by tags
+- **Dark Mode Support**: Toggle between light and dark themes
+- **Responsive Design**: Optimized for both desktop and mobile devices
+- **Similar Jobs**: Discover related job opportunities
+- **Interactive UI**: Modern user interface with hover effects and smooth transitions
+
+## Tech Stack
+
+- **Vue 3**: Using the Composition API with `<script setup>` syntax
+- **Vite**: For fast development and optimized builds
+- **SCSS**: For advanced styling capabilities
+- **CSS Variables**: For theme support (light/dark mode)
+
+## Components
+
+- **App.vue**: Main application component with job listings
+- **JobCard.vue**: Component for displaying individual job postings
+- **JobDetail.vue**: Component for displaying detailed job information
+- **JobFilters.vue**: Component for filtering job listings
+- **SideNav.vue**: Navigation sidebar component
+- **Dashboard.vue**: Dashboard view component
+- **Applications.vue**: Job applications management component
+- **SavedJobs.vue**: Saved jobs management component
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (v14 or later)
+- Yarn package manager
+
+### Installation
+
+```bash
+# Clone the repository
+git clone https://repo.loxx.one/pankan/jobs.git
+cd jobs
+
+# Install dependencies
+yarn install
+
+# Start the development server
+yarn dev
+```
+
+### Build for Production
+
+```bash
+yarn build
+```
+
+## Project Structure
+
+```
+/src
+  /assets
+    /scss
+      main.scss       # Main stylesheet
+      variables.scss  # SCSS variables and mixins
+  /components         # Vue components
+  App.vue             # Main application component
+  main.js             # Application entry point
+```
+
+## Future Enhancements
+
+- User authentication and profiles
+- Job application submission
+- Advanced filtering and search capabilities
+- Company profiles and reviews
+- Email notifications for new job postings
+- Mobile application using the same codebase