Skip to content

Alpha4Coders/Alpha-Coders

Repository files navigation

πŸš€ Alpha Coders

A vibrant community platform for passionate developers to collaborate, learn, and build amazing things together.

Deploy with Vercel

✨ Features

Community Engagement

  • Community Member Directory - Discover and connect with community members, view profiles with names and usernames
  • Core Team Highlights - Meet the founding members: Vortex-16, Dealer-09, Rouvik, and PixelPioneer404
  • Interactive UI - Smooth animations and transitions powered by Framer Motion

Project Showcase

  • GitHub Project Integration - Automatically fetch and display projects from Alpha4Coders GitHub Organization
  • Advanced Filtering - Filter projects by technology, category, and status
  • Project Cards - Beautiful card-based layout with detailed project information

Modern Development Experience

  • AI-Powered Features - Integrated Google Genkit for AI capabilities
  • Dark Mode Support - Seamless theme switching with next-themes
  • Type-Safe - Full TypeScript support for robust development
  • Responsive Design - Works flawlessly across all devices and screen sizes

🎨 Design System

Color Palette

  • Primary Color: Deep Blue (#34495E) - Evokes trust, stability, and community
  • Background: Light Gray (#F0F3F4) - Clean, modern backdrop
  • Accent Color: Bright Cyan (#48C9B0) - Interactive elements and key highlights

Typography & UX

  • Font: Inter (sans-serif) - Modern, readable, and elegant
  • Icons: Minimalist outline-style icons via Lucide React
  • Layout: Card-based design for optimal visual separation and scanning
  • Interactions: Subtle transitions and hover effects for enhanced user feedback

πŸ› οΈ Tech Stack

Frontend

Backend & Data

  • Firebase: Real-time database and authentication
  • Database: Cloud Firestore integration
  • API Integration: GitHub API for project fetching

AI & Utilities

  • Genkit: Google Genkit for AI capabilities
  • Form Handling: React Hook Form with Zod validation
  • Charts: Recharts for data visualization
  • Date Handling: date-fns for date utilities

Development Tools

  • Language: TypeScript for type safety
  • Build Tool: Next.js with Turbopack
  • Package Manager: npm/yarn
  • Linting: ESLint integration

πŸš€ Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Git

Installation

  1. Clone the repository
git clone https://github.com/Vortex-16/Alpha-Coders-V-2.git
cd Alpha-Coders-V-2
  1. Install dependencies
npm install
# or
yarn install
  1. Set up environment variables

Create a .env.local file in the root directory with your Firebase and API credentials:

NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
NEXT_PUBLIC_GENKIT_API_KEY=your_genkit_key
  1. Run the development server
npm run dev
# or
yarn dev

Open http://localhost:9002 in your browser to see the application.

πŸ“š Available Scripts

# Start development server with Turbopack (port 9002)
npm run dev

# Start Genkit in development mode
npm run genkit:dev

# Watch Genkit files for changes
npm run genkit:watch

# Build for production
npm run build

# Start production server
npm start

# Run linting
npm run lint

# Type check without emitting
npm run typecheck

πŸ“ Project Structure

src/
β”œβ”€β”€ app/                          # Next.js app directory
β”‚   β”œβ”€β”€ layout.tsx               # Root layout with theme provider
β”‚   β”œβ”€β”€ page.tsx                 # Home page
β”‚   β”œβ”€β”€ custom-styles.css        # Custom component styles
β”‚   β”œβ”€β”€ globals.css              # Global styles
β”‚   β”œβ”€β”€ community/               # Community member listing
β”‚   └── team/                    # Core team showcase
β”‚
β”œβ”€β”€ components/
β”‚   β”œβ”€β”€ ui/                      # Shadcn UI components library
β”‚   β”‚   β”œβ”€β”€ button.tsx           # Button component
β”‚   β”‚   β”œβ”€β”€ card.tsx             # Card component
β”‚   β”‚   β”œβ”€β”€ dialog.tsx           # Dialog/modal component
β”‚   β”‚   β”œβ”€β”€ accordion.tsx        # Accordion component
β”‚   β”‚   └── ... (25+ more)
β”‚   β”‚
β”‚   β”œβ”€β”€ header.tsx               # Navigation header
β”‚   β”œβ”€β”€ theme-provider.tsx       # Theme configuration
β”‚   β”œβ”€β”€ theme-toggle.tsx         # Dark/light mode toggle
β”‚   β”œβ”€β”€ motion-div.tsx           # Animated wrapper component
β”‚   β”œβ”€β”€ project-card.tsx         # Individual project card
β”‚   β”œβ”€β”€ projects-section.tsx     # Projects showcase section
β”‚   β”œβ”€β”€ community-section.tsx    # Community members section
β”‚   β”œβ”€β”€ team-section.tsx         # Core team section
β”‚   └── stars.tsx                # Background animation
β”‚
β”œβ”€β”€ hooks/
β”‚   β”œβ”€β”€ use-mobile.tsx           # Mobile detection hook
β”‚   └── use-toast.ts             # Toast notification hook
β”‚
β”œβ”€β”€ lib/
β”‚   β”œβ”€β”€ data.ts                  # Static data
β”‚   β”œβ”€β”€ utils.ts                 # Utility functions
β”‚   β”œβ”€β”€ placeholder-images.ts    # Image placeholders
β”‚   └── placeholder-images.json  # Image data
β”‚
β”œβ”€β”€ ai/
β”‚   β”œβ”€β”€ genkit.ts                # Genkit configuration
β”‚   └── dev.ts                   # AI development utilities
β”‚
└── types.ts                     # TypeScript type definitions

public/                          # Static assets
docs/
β”œβ”€β”€ blueprint.md                # Project design specifications

🌐 Pages

  • Home (/) - Welcome page with features and call-to-action
  • Community (/community) - Community member directory
  • Team (/team) - Core team highlights and introductions

πŸ”§ Configuration Files

πŸš€ Deployment

Deploy to Vercel (Recommended)

  1. Click the "Deploy with Vercel" button at the top of this README
  2. Log in with your GitHub account
  3. Authorize the Vercel integration
  4. Configure your environment variables in Vercel
  5. Deploy with a single click!

Manual Deployment

# Build the project
npm run build

# Start the production server locally
npm start

# Deploy to your hosting provider
# (Follow your provider's deployment instructions)

For detailed deployment steps, see the Next.js deployment documentation.

πŸ“– Development Guide

Adding New Components

  1. Create a new component file in src/components
  2. Use Tailwind CSS for styling
  3. Integrate with Framer Motion for animations
  4. Add type definitions to src/types.ts

Working with Firebase

Firebase is pre-configured for authentication and data storage. Update your credentials in .env.local to get started.

Using Genkit for AI Features

The project includes Google Genkit integration:

# Start Genkit development server
npm run genkit:dev

# Or with watch mode
npm run genkit:watch

Check src/ai/genkit.ts for configuration and src/ai/dev.ts for examples.

🎯 Key Features Explained

Projects Section

Automatically fetches projects from the Alpha4Coders GitHub organization with:

  • Dynamic project filtering
  • Technology/category-based search
  • GitHub links and metadata
  • Responsive card layout

Community Section

Interactive member directory featuring:

  • Member profiles and usernames
  • Core team members highlighted prominently
  • Avatar support
  • Smooth loading animations

Theme System

  • System preference detection
  • Manual dark/light mode toggle
  • Persistent theme preference
  • Smooth transitions between themes

🀝 Contributing

We welcome contributions from the community! Here's how:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“ Code Style

  • TypeScript: Strict mode enabled
  • Formatting: Follow existing code style
  • Components: Functional components with hooks
  • Styling: Tailwind CSS utility classes
  • Type Safety: Avoid any types

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ”— Links

πŸ‘₯ Core Team

  • Vortex-16 - Project Lead
  • Dealer-09 - Core Developer
  • Rouvik - Core Developer
  • PixelPioneer404 - Core Developer

πŸ™ Acknowledgments

πŸ“ž Support

For questions or issues:


Made with ❀️ by the Alpha Coders Community

Releases

No releases published

Packages

No packages published

Languages