docs: add local development docs

README.md

@@ -1,8 +1,78 @@
-# React + Vite
+# ALiAS Website Source
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+Here you'll find the source code of [lucknow.asetalias.in](lucknow.asetalias.in).
 
-Currently, two official plugins are available:
+## 🚀 Project Overview
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+Within this project, you'll find the following folders and files:
+
+```bash
+.
+├── README.md
+├── index.html
+├── package.json
+├── pnpm-lock.yaml
+├── public
+│   ├── assets
+│   │   ├── icons
+│   │   └── images
+│   └── data
+│       ├── about.json
+│       ├── alumni.json
+│       ├── events.json
+│       ├── members.json
+│       └── socials.json
+├── src
+│   ├── App.css
+│   ├── App.jsx
+│   ├── components
+│   │   ├── AboutUs
+│   │   ├── Alumni
+│   │   ├── Community
+│   │   ├── Contact
+│   │   ├── Events
+│   │   ├── Hero
+│   │   ├── Navbar
+│   │   ├── Reusables
+│   │   └── Team
+│   ├── index.css
+│   ├── main.jsx
+│   ├── pages
+│   │   └── Home
+│   └── variables.css
+└── vite.config.js
+```
+
+The public/data directory contains various JSON files for adding events, volunteers, and alumni.
+
+## 🛠️ Contribution and Local Development
+
+To contribute to this project or run it locally, follow these instructions:
+
+### Installation
+
+1. Navigate to the project's root directory using your terminal.
+
+2. Run the following command to install the necessary dependencies:
+
+   ```bash
+   pnpm install
+   ```
+
+### Local Development
+
+1. After installing the dependencies, start the local development server by running:
+
+   ```bash
+   pnpm dev
+   ```
+
+   This will launch the server, and you can access the site at [`localhost:3000`](https://localhost:3000) in your browser.
+
+2. Make your desired changes to the project files.
+
+3. If you want to contribute, please fork the repository, create a branch for your changes, and submit a pull request.
+
+### Questions or Discussions
+
+Join our [Discord server](https://discord.gg/jKhDqHBbMy) for any questions, discussions, or further assistance.