Updated Readme File

README.md

@@ -1,36 +1,116 @@
-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).
+<div align="center">
+  <br />
+    <a href="https://yc-directory.ansulagrawal.in/" target="_blank">
+      <img src="https://raw.githubusercontent.com/ansulagrawal/yc-directory/refs/heads/main/public/github-banner.png" alt="Project Banner">
+    </a>
+  <br />
 
-## Getting Started
+  <div>
+    <img src="https://img.shields.io/badge/-Typescript-black?style=for-the-badge&logoColor=white&logo=react&color=3178C6" alt="typescript" />
+    <img src="https://img.shields.io/badge/-Next_JS-black?style=for-the-badge&logoColor=white&logo=nextdotjs&color=000000" alt="next.js" />
+    <img src="https://img.shields.io/badge/-Tailwind_CSS-black?style=for-the-badge&logoColor=white&logo=tailwindcss&color=06B6D4" alt="tailwind css" />
+    <img src="https://img.shields.io/badge/-Sanity-black?style=for-the-badge&logoColor=white&logo=sanity&color=F03E2F" alt="sanity" />
 
-First, run the development server:
+  </div>
+
+<h3 align="center">Startup Directory Platform</h3>
+</div>
+
+## 📋 <a name="table">Table of Contents</a>
+
+1. 🤖 [Introduction](#introduction)
+2. ⚙️ [Tech Stack](#tech-stack)
+3. 🔋 [Features](#features)
+4. 🤸 [Quick Start](#quick-start)
+
+## <a name="introduction">🤖 Introduction</a>
+
+A Next.js 15 platform where entrepreneurs can submit their startup ideas for virtual pitch competitions, browse other
+pitches, and gain exposure through a clean minimalistic design for a smooth user experience.
+
+## <a name="tech-stack">⚙️ Tech Stack</a>
+
+- React 19
+- Next.js 15
+- Sanity
+- TailwindCSS
+- ShadCN
+- TypeScript
+
+## <a name="features">🔋 Features</a>
+
+👉 **Live Content API**: Displays the latest startup ideas dynamically on the homepage using Sanity's Content API.
+
+👉 **GitHub Authentication**: Allows users to log in easily using their GitHub account.
+
+👉 **Pitch Submission**: Users can submit startup ideas, including title, description, category, and multimedia links (
+image or video).
+
+👉 **View Pitches**: Browse through submitted ideas with filtering options by category.
+
+👉 **Pitch Details Page**: Click on any pitch to view its details, with multimedia and description displayed.
+
+👉 **Profile Page**: Users can view the list of pitches they've submitted.
+
+👉 **Editor Picks**: Admins can highlight top startup ideas using the "Editor Picks" feature managed via Sanity Studio.
+
+👉 **Views Counter**: Tracks the number of views for each pitch instead of an upvote system.
+
+👉 **Search**: Search functionality to load and view pitches efficiently.
+
+👉 **Minimalistic Design**: Fresh and simple UI with only the essential pages for ease of use and a clean aesthetic.
+
+and many more, including the latest **React 19**, **Next.js 15** and **Sanity** features alongside code architecture and
+reusability
+
+## <a name="quick-start">🤸 Quick Start</a>
+
+Follow these steps to set up the project locally on your machine.
+
+**Prerequisites**
+
+Make sure you have the following installed on your machine:
+
+- [Git](https://git-scm.com/)
+- [Node.js](https://nodejs.org/en)
+- [npm](https://www.npmjs.com/) (Node Package Manager)
+
+**Cloning the Repository**
 
 ```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
+git clone https://github.com/ansulagrawal/yc-directory.git
+cd yc-directory
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+**Installation**
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+Install the project dependencies using npm:
 
-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.
+```bash
+npm install
+```
 
-## Learn More
+**Set Up Environment Variables**
 
-To learn more about Next.js, take a look at the following resources:
+Create a new file named `.env.local` in the root of your project and add the following content:
 
-- [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.
+```env
+NEXT_PUBLIC_SANITY_API_VERSION='vX'
+NEXT_PUBLIC_SANITY_PROJECT_ID=
+NEXT_PUBLIC_SANITY_DATASET=
+SANITY_TOKEN=
+AUTH_SECRET=
+AUTH_GITHUB_ID=
+AUTH_GITHUB_SECRET=
+```
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+Replace the placeholder values with your actual Sanity credentials. You can obtain these credentials by signing up &
+creating a new project on the [Sanity website](https://www.sanity.io/).
 
-## Deploy on Vercel
+**Running the Project**
 
-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.
+```bash
+npm run dev
+```
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.