From ab357f26224ac0d03e2d8de31b75b6d38c0f88e2 Mon Sep 17 00:00:00 2001 From: Roshni Roshni Date: Fri, 4 Jul 2025 16:42:46 +0530 Subject: [PATCH] docs: Improve README with project info, setup, and contribution guide --- README.md | 49 ++++++++++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 66bb426..021d318 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,39 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# 🌸 GSSoC 2025 – Official Website -## Getting Started +Welcome to the official website repository of **GirlScript Summer of Code 2025** – an open-source program that empowers students to contribute to real-world projects with guidance from mentors. -First, run the development server: +--- -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +## 🌟 Features -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +- Beautiful landing page with program details +- Contributor and project dashboards +- Mentor listing +- Responsive UI (mobile-friendly) -You can start editing the page by modifying `app/page.js`. 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. +## 💻 Tech Stack -## Learn More +| Tech | Description | +|--------------|-------------------------------------| +| Next.js | React-based web framework | +| Tailwind CSS | Utility-first CSS framework | +| Vercel | For seamless deployment | -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. +## 🚀 Getting Started -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! +### Run Locally -## Deploy on Vercel +```bash +# Clone your fork +git clone https://github.com/your-username/GSSoC-2025-Website.git +cd GSSoC-2025-Website -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. +# Install dependencies +npm install -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +# Start development server +npm run dev