Merge pull request #110 from CodeChefVIT/aditi/readme

fix: readme update

Author: Abh1noob

README.md

@@ -1,36 +1,245 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+<p align="center"><a href="https://www.codechefvit.com" target="_blank"><img src="https://i.ibb.co/4J9LXxS/cclogo.png" width=160 title="CodeChef-VIT" alt="Codechef-VIT"></a>
+</p>
 
-## Getting Started
+<h2 align="center"> DEVSOC'25 Portal</h2>
+<br/>
 
-First, run the development server:
+
+> <p>Welcome to Code of DEVSOC'25 Portal, Enhance your hackathon journey with this Portal brought to you by CodeChef-VIT! Form teams, submit ideas, choose tracks, and manage presentations effortlessly. Collaborate effectively, refine your projects, and stay on top of your submissions with our streamlined platform.</p>
+## 🌐 Deploy
+[https://portal.devsoc25.codechefvit.com/](https://portal.devsoc25.codechefvit.com/)
+
+## ⚙️ Tech Stack:
+
+- [Next.js](https://nextjs.org/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Tailwind CSS](https://tailwindcss.com/)
+- [Zustand](https://zustand-demo.pmnd.rs/)
+- [ShadCN](https://ui.shadcn.com/)
+- [React Hot Toast](https://react-hot-toast.com/)
+- [Axios](https://axios-http.com/)
+
+
+## 💡 Features:
+
+- **Form Teams:** Create and manage your hackathon team. 
+
+- **Choose Tracks:** Select a track that aligns with your project.  
+
+- **Edit Teams:** Modify your team, including kicking out members if necessary.  
+
+- **Submit Ideas:** Share and update your project ideas.  
+
+- **Upload Presentations:** Submit project presentations for review rounds. 
+
+- **Seamless UI:** Experience a clean and user-friendly interface.  
+
+
+## 🖼 Screenshots
+
+<p align="center">
+
+
+#### Signup
+
+<img width="1440" alt="Signup" src="portal-img/signup.png">
+
+#### Login 
+<img width="1440" alt="Login" src="portal-img/login.png">
+
+#### OnBoarding
+<img width="1440" alt="TellUsMore" src="portal-img/tellus.png">
+
+#### Dashboard
+
+<img width="1440" alt="dashboard" src="portal-img/dashboard.png">
+
+#### Project Submission
+<img width="1440" alt="Submit" src="portal-img/submit.png">
+
+#### Track Details
+<img width="1440" alt="TrackDetails" src="portal-img/track.png">
+
+</p>
+
+## 🏁 Get Started
+
+To get started, fork your own copy and clone the main branch. To clone a branch you can run the following:
+
+```bash
+git clone -b main https://github.com/<Your username>/devsoc-portal-25.git
+```
+
+Run these commands on your bash/terminal and open it in a code editor of your choice.
+
+Run the following to install all the dependencies:
+
+```bash
+pnpm i
+```
+
+To start your development server run:
 
 ```bash
-npm run dev
-# or
-yarn dev
-# or
 pnpm dev
-# or
-bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## 📝 Checkout:
+
+- DEVSOC'25 Landing: [https://github.com/CodeChefVIT/devsoc-landing-25](https://github.com/CodeChefVIT/devsoc-landing-25)
+- DEVSOC'25 Admin: [https://github.com/CodeChefVIT/devsoc-admin-25](https://github.com/CodeChefVIT/devsoc-admin-25)
+- DEVSOC'25 Backend: [https://github.com/CodeChefVIT/devsoc-be-25](https://github.com/CodeChefVIT/devsoc-be-25)
+
+## 🚀 Contributors
+
+<table>
+<tr align="center">
+<td>
+	<p align="center">
+		<img src="https://avatars.githubusercontent.com/u/67090539?v=4" width="170" height="170" alt="profilepic" style="border: 2px solid grey;">
+	</p>
+	<p style="font-size:17px; font-weight:600;">Abhinav Pant</p>
+	<p align="center">
+		<a href="https://github.com/abhitrueprogrammer">
+			<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
+		</a>
+		<a href="https://www.linkedin.com/in/abhinav-pant/">
+			<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
+		</a>
+	</p>
+</td>
+
+<td>
+	<p align="center">
+		<img src="https://avatars.githubusercontent.com/u/56132559?v=4" width="170" height="170" alt="profilepic" style="border: 2px solid grey;">
+	</p>
+	<p style="font-size:17px; font-weight:600;">Abhinav Ganeshan</p>
+	<p align="center">
+		<a href="https://github.com/Abh1noob">
+			<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
+		</a>
+		<a href="https://www.linkedin.com/in/abhinav-gk/">
+			<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
+		</a>
+	</p>
+</td>
+
+<td>
+	<p align="center">
+		<img src="https://avatars.githubusercontent.com/u/84934511?v=4" width="170" height="170" alt="profilepic" style="border: 2px solid grey;">
+	</p>
+	<p style="font-size:17px; font-weight:600;">Nishant Gupta</p>
+	<p align="center">
+		<a href="https://github.com/NishantGupt786">
+			<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
+		</a>
+		<a href="https://www.linkedin.com/in/nishant-gupta-12913221b/">
+			<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
+		</a>
+	</p>
+</td>
+</tr>
+
+<tr align="center">
+<td>
+	<p align="center">
+		<img src="https://avatars.githubusercontent.com/u/148696092?v=4" width="170" height="170" alt="profilepic" style="border: 2px solid grey;">
+	</p>
+	<p style="font-size:17px; font-weight:600;">Aryan Garg</p>
+	<p align="center">
+		<a href="https://github.com/Aryan-Garg-dev">
+			<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
+		</a>
+		<a href="https://www.linkedin.com/in/aryan-garg-dev/">
+			<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
+		</a>
+	</p>
+</td>
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+<td>
+	<p align="center">
+		<img src="https://avatars.githubusercontent.com/u/157038896?v=4" width="170" height="170" alt="profilepic" style="border: 2px solid grey;">
+	</p>
+	<p style="font-size:17px; font-weight:600;">Aditi Saxena</p>
+	<p align="center">
+		<a href="https://github.com/aditisaxena259">
+			<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
+		</a>
+		<a href="https://www.linkedin.com/in/aditi-saxena-4674ab222/">
+			<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
+		</a>
+	</p>
+</td>
 
-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.
+<td>
+	<p align="center">
+		<img src="https://avatars.githubusercontent.com/u/88274018?v=4" width="170" height="170" alt="profilepic" style="border: 2px solid grey;">
+	</p>
+	<p style="font-size:17px; font-weight:600;">Harshit Sarma</p>
+	<p align="center">
+		<a href="https://github.com/kashyap-harshit">
+			<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
+		</a>
+		<a href="https://www.linkedin.com/in/harshit-sarma-247175179">
+			<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
+		</a>
+	</p>
+</td>
+</tr>
 
-## Learn More
+<tr align="center">
+<td>
+	<p align="center">
+		<img src="https://avatars.githubusercontent.com/u/142434600?v=4" width="170" height="170" alt="profilepic" style="border: 2px solid grey;">
+	</p>
+	<p style="font-size:17px; font-weight:600;">Samya Mehta</p>
+	<p align="center">
+		<a href="https://github.com/samyamehta16">
+			<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
+		</a>
+		<a href="https://www.linkedin.com/in/samyamehta16/">
+			<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
+		</a>
+	</p>
+</td>
 
-To learn more about Next.js, take a look at the following resources:
+<td>
+	<p align="center">
+		<img src="https://avatars.githubusercontent.com/u/71623796?v=4" width="170" height="170" alt="profilepic" style="border: 2px solid grey;">
+	</p>
+	<p style="font-size:17px; font-weight:600;">Vedant Matanhelia</p>
+	<p align="center">
+		<a href="https://github.com/RajivDalal">
+			<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
+		</a>
+		<a href="https://www.linkedin.com/in/vedant-matanhelia-aa171027b/">
+			<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
+		</a>
+	</p>
+</td>
 
-- [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.
+<td>
+	<p align="center">
+		<img src="https://avatars.githubusercontent.com/u/145206236?v=4" width="170" height="170" alt="profilepic" style="border: 2px solid grey;">
+	</p>
+	<p style="font-size:17px; font-weight:600;">Dhruv S Chopra</p>
+	<p align="center">
+		<a href="https://github.com/DhruvsChopra">
+			<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
+		</a>
+		<a href="https://www.linkedin.com/in/dhruv-singh-177167287/">
+			<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
+		</a>
+	</p>
+</td>
+</tr>
+</table>
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
 
-## Deploy on Vercel
+## License
 
-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.
+[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+<p align="center">
+	Made with :heart: by <a href="https://www.codechefvit.com" target="_blank">CodeChef-VIT</a>
+</p>