Geek Room KIET is the official website for the Geek Room chapter at KIET (Krishna Institute of Engineering and Technology). We're a passionate community of students dedicated to fostering a dynamic tech culture through interdisciplinary learning, hands-on workshops, coding sessions, and collaborative projects.
- Empower students to sharpen their technical expertise
- Explore cutting-edge technologies and build innovative projects
- Foster collaboration through workshops, competitions, and team projects
- Create a supportive space for students to connect, learn, and make a lasting impact
- Project Structure - Complete folder organization guide
- Contributing Guide - How to contribute to the project
- Splash Screen: Eye-catching animated introduction
- Why Join Us: Compelling reasons to join our community
- Statistics: Live member count and event statistics
- Gallery Carousel: Showcase of past events and activities
- Team Structure: Interactive team cards with smooth animations
- Contact Form: Easy way to get in touch with us
- Modern UI: Clean, professional design with dark theme
- Responsive: Optimized for all devices (mobile, tablet, desktop)
- Smooth Animations: CSS-based animations for better performance
- Accessibility: Built with accessibility best practices
- Fast Loading: Optimized for speed and performance
- Next.js 15: Latest React framework with App Router
- TypeScript: Type-safe development
- Tailwind CSS: Utility-first CSS framework
- GSAP Animations: Smooth, performant animations
- Form Handling: React Hook Form with validation
- Image Optimization: Next.js Image component for optimal loading
- Node.js 18.0 or later
- Bun (recommended) or npm/yarn/pnpm
-
Clone the repository
git clone https://github.com/your-username/geekroom-kiet.git cd geekroom-kiet -
Install dependencies
# Using Bun (recommended) bun install # Or using npm npm install # Or using yarn yarn install
-
Start the development server
# Using Bun bun run dev # Or using npm npm run dev # Or using yarn yarn dev
-
Open your browser Navigate to http://localhost:3000 to see the website.
- Want to contribute? Check out our Contributing Guide
- Need help? Open an issue
- Have questions? Join our community discussions
- Explore the codebase? Read our Project Structure Guide
geekroom-kiet/
├── public/ # Static assets
│ ├── images/ # Image assets organized by category
│ │ ├── team/ # Team member photos
│ │ ├── events/ # Event photos
│ │ ├── gallery/ # Gallery images
│ │ └── logos/ # Logo variations
│ ├── icons/ # Icon files
│ ├── favicon.ico # Favicon
│ └── og-image.png # Open Graph image
├── src/
│ ├── app/ # Next.js App Router
│ │ ├── api/ # API routes
│ │ ├── globals.css # Global styles
│ │ ├── layout.tsx # Root layout
│ │ ├── page.tsx # Homepage
│ │ ├── blogs/ # Blog pages
│ │ ├── events/ # Events pages
│ │ ├── gallery/ # Gallery pages
│ │ ├── join-us/ # Join us page
│ │ ├── projects/ # Projects pages
│ │ └── team/ # Team pages
│ ├── components/ # React components
│ │ ├── ui/ # Reusable UI components
│ │ ├── layout/ # Layout components
│ │ ├── features/ # Feature-based components
│ │ │ ├── contact/ # Contact feature
│ │ │ ├── events/ # Events feature
│ │ │ ├── projects/ # Projects feature
│ │ │ ├── team/ # Team feature
│ │ │ ├── gallery/ # Gallery feature
│ │ │ └── blogs/ # Blogs feature
│ │ ├── common/ # Common components
│ │ └── providers/ # Context providers
│ ├── hooks/ # Custom React hooks
│ │ ├── useLocalStorage.ts
│ │ ├── useIntersectionObserver.ts
│ │ ├── useDebounce.ts
│ │ └── index.ts
│ ├── types/ # TypeScript definitions
│ │ ├── index.ts # Main types
│ │ ├── api.ts # API types
│ │ └── components.ts # Component types
│ ├── utils/ # Utility functions
│ │ ├── api.ts # API client
│ │ ├── validation.ts # Form validation
│ │ ├── format.ts # Data formatting
│ │ └── index.ts
│ ├── constants/ # Application constants
│ │ └── index.ts
│ ├── lib/ # Library code
│ │ └── utils.ts
│ └── data/ # Static data
├── docs/ # Documentation
├── tests/ # Test files
├── scripts/ # Build scripts
├── .github/ # GitHub workflows
├── CONTRIBUTING.md # Contribution guidelines
├── FOLDER_STRUCTURE.md # Detailed folder structure
├── package.json # Dependencies and scripts
├── tailwind.config.ts # Tailwind configuration
├── tsconfig.json # TypeScript configuration
└── next.config.js # Next.js configuration
📋 Detailed Structure: See FOLDER_STRUCTURE.md for a comprehensive breakdown of the ideal GSoC-level project organization.
- Framework: Next.js 15.2.0 with App Router
- Language: TypeScript 5.0
- Styling: Tailwind CSS 3.4.1
- UI Components: Radix UI primitives
- Icons: Lucide React
- Animations: GSAP 3.12.7
- Forms: React Hook Form with Zod validation
- Package Manager: Bun (with npm/yarn support)
- Linting: Biome (ESLint alternative)
- Type Checking: TypeScript
- Code Formatting: Biome formatter
- Platform: Vercel (recommended)
- Static Export: Supported for other platforms
We welcome contributions from the community! Please follow these steps to get started:
📋 Before you start: Make sure to read our Contributing Guide for detailed guidelines and best practices.
- Go to the Geek Room KIET repository
- Click the "Fork" button in the top-right corner
- This creates a copy of the project in your GitHub account
# Replace YOUR-USERNAME with your GitHub username
git clone https://github.com/YOUR-USERNAME/geekroom-kiet.git
cd geekroom-kiet# Add the original repository as upstream
git remote add upstream https://github.com/your-username/geekroom-kiet.git
# Verify your remotes
git remote -v# Create and switch to a new branch
git checkout -b feat/your-feature-name
# Examples:
# git checkout -b feat/add-new-component
# git checkout -b fix/navbar-bug
# git checkout -b docs/update-readme- Make your changes locally
- Test your changes thoroughly
- Follow the existing code style
- Write clear commit messages
# Stage your changes
git add .
# Commit with a descriptive message
git commit -m "feat: Add new component for better UX"
# Examples of good commit messages:
# "feat: Add dark mode toggle"
# "fix: Resolve navbar alignment issue"
# "docs: Update installation instructions"# Push your branch to your fork
git push origin feat/your-feature-name- Go to your fork on GitHub
- Click "Compare & pull request"
- Fill out the PR template with:
- Clear description of changes
- Screenshots (for UI changes)
- Link to related issues
- Submit the pull request
# Fetch latest changes from upstream
git fetch upstream
# Switch to main branch
git checkout main
# Merge upstream changes
git merge upstream/main
# Push updates to your fork
git push origin main- Read our Contributing Guide for detailed guidelines
- Understand our Project Structure before making changes
- Follow the existing code style and patterns
- Write clear, descriptive commit messages
- Test your changes locally before submitting
- Update documentation if needed
- Be respectful and collaborative in discussions
- Ask questions if you're unsure about anything
- Check the Issues tab
- Look for issues labeled
good first issueorhelp wantedto start with open-source - Comment on the issue to express interest
- Wait for assignment before starting work
- Geek Room Global for the inspiration and community support
- KIET for providing the platform for our tech community
- All Contributors who help make this project better
- Open Source Community for the amazing tools and libraries
Made with ❤️ by Geek Room KIET