diff --git a/README.md b/README.md index 183afc1..7e2ac37 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ > A collaborative platform for college students to share, discover, and contribute to real-time academic and personal projects — like LinkedIn for student projects. +[![Next.js](https://img.shields.io/badge/Next.js-14-black?style=for-the-badge&logo=next.js)](https://nextjs.org/) +[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/) +[![Prisma](https://img.shields.io/badge/Prisma-2D3748?style=for-the-badge&logo=prisma&logoColor=white)](https://www.prisma.io/) +[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white)](https://www.postgresql.org/) +[![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/) + --- ## 📌 Overview @@ -30,20 +36,6 @@ Built as a group project by our class to streamline and enrich collaborative lea --- -## 🧑‍🤝‍🧑 Team Members - -> Project by students of **[Your College Name]** — Group [A/B/C] - -| Name | Role | GitHub | -|------|------|--------| -| Shikhar Shetty | Developer | [@Shikhar-Shetty](https://github.com/Shikhar-Shetty) | -| Sunpreeth | Developer | [@Sunpreeth](https://github.com/anysdefdefe) | -| Vaishnav | Developer | [@vaish73](https://github.com/vaish73) | -| Shravan Raj | Developer | [@Shravan-Raj](https://github.com/ShravanRajj) | -| Shreyas BS | Developer | [@Shreyas-BSj](https://github.com/Shreyas-99) | - ---- - ## 🔑 Features - 📋 **Post and manage your project listings** @@ -55,48 +47,57 @@ Built as a group project by our class to streamline and enrich collaborative lea --- -## Installation +## 🚀 Quick Start + +Ready to get ProjectStack running locally? Follow these simple steps: + +### Prerequisites +- **Node.js** (v18 or higher) +- **PostgreSQL** database (we recommend [Neon](https://neon.tech/) for free hosting) +- **Git** + +### Installation -### 1. Clone the repo ```bash +# 1. Clone and navigate to the project git clone https://github.com/yourusername/projectstack.git cd projectstack -``` -### 2. Install dependencies -```bash +# 2. Install dependencies npm install -``` -### 3. Setup environment variables -```bash +# 3. Set up your environment variables cp .env.example .env ``` -### 4. Configure PostgreSQL connection in `.env` -```bash -DATABASE_URL="postgresql://..." +### Environment Setup + +Open your `.env` file and add these required variables: + +```env +# Database (get from Neon, Supabase, or your PostgreSQL provider) +DATABASE_URL="postgresql://username:password@host:port/database" + +# Authentication (generate a random secret) +NEXTAUTH_SECRET="your-super-secret-key" +NEXTAUTH_URL="http://localhost:3000" + +# OAuth (optional - for Google sign-in) +GOOGLE_CLIENT_ID="your-google-client-id" +GOOGLE_CLIENT_SECRET="your-google-client-secret" ``` -### 5. Push schema +### Database Setup & Launch + ```bash +# Set up your database schema npx prisma db push -``` -### 6. Start dev server -```bash +# Start the development server npm run dev ``` ---- -## Environmental Variable Setup -```bash - DATABASE_URL=postgresql://... - NEXTAUTH_SECRET=your-secret - NEXTAUTH_URL=http://localhost:3000 - GOOGLE_CLIENT_ID=... - GOOGLE_CLIENT_SECRET=... -``` +🎉 **That's it!** Open [http://localhost:3000](http://localhost:3000) and start exploring ProjectStack! --- ## 🤝 Join the Mission — We're Open for Collaborators! @@ -125,7 +126,15 @@ Whether you're a developer, designer or just a curious learner — if the vision 🐳 Docker + Vercel + GitHub CI/CD for production-grade DevOps -## 📬 How to Reach Us +## 📋 How to Contribute -Drop an issue in the GitHub repo or shoot a message on LinkedIn/GitHub/Instagram to any of the team members listed above. +1. **Check out our [Issues](https://github.com/Shikhar-Shetty/ProjectStack/issues)** for beginner-friendly tasks +2. **Fork the repository** and create your feature branch +3. **Follow our coding standards** (ESLint) +4. **Submit a Pull Request** with a clear description + + +## 📬 How to Reach Us +We’d love to hear from you! +Got suggestions or found a bug? Open an issue on [GitHub](https://github.com/Shikhar-Shetty/ProjectStack) \ No newline at end of file