diff --git a/README.md b/README.md index ee93b73..5e895cf 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,31 @@ # Code Brew +
+ [![GitHub](https://img.shields.io/badge/GitHub-crafter--station-181717?logo=github)](https://github.com/crafter-station) +[![Next.js](https://img.shields.io/badge/Next.js-16-black?logo=next.js)](https://nextjs.org) +[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue?logo=typescript)](https://www.typescriptlang.org/) +[![Tailwind CSS](https://img.shields.io/badge/Tailwind-4-38bdf8?logo=tailwind-css)](https://tailwindcss.com/) +[![License](https://img.shields.io/badge/License-MIT-green.svg)]() **Monthly meetups for software engineers, designers, founders, and tech professionals across Latin America and Spain.** -Visit the live site at [codebrew.tech](https://codebrew.tech) +[Visit Website](https://codebrew.tech) โ€ข [Partnership Deck](https://codebrew.tech/deck) โ€ข [Join Community](https://crafters.chat/) + +
+ +--- + +## ๐ŸŒŸ Features + +- **๐ŸŒ Interactive 3D Globe** - Explore Code Brew cities with an interactive globe powered by COBE +- **๐Ÿ“Š Live Stats** - Real-time GitHub stars and community metrics +- **๐ŸŽจ Modern Design System** - Void black + signal red brutalist design language +- **๐Ÿ“ฑ Fully Responsive** - Optimized for all devices from mobile to desktop +- **๐ŸŽญ Partnership Deck** - Interactive slide deck with keyboard and touch navigation +- **โšก Performance** - Built with Next.js 16 App Router for optimal speed +- **๐ŸŽฌ Smooth Animations** - Powered by Motion for delightful interactions +- **โ™ฟ Accessible** - Following web accessibility best practices --- @@ -98,27 +119,93 @@ npm start npm run lint ``` +### Asset Generation + +Generate brand assets (OG images, favicon): + +```bash +bun scripts/generate-assets.ts +``` + +This creates: +- `public/og.png` (1200ร—630 Open Graph image) +- `public/og-twitter.png` (1200ร—600 Twitter card) +- `app/favicon.ico` (multi-size icon: 16, 32, 48px) + +--- + +## Deployment + +This project is optimized for deployment on [Vercel](https://vercel.com): + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/crafter-station/codebrew.tech) + +The site automatically deploys on push to the main branch. No environment variables are required for basic deployment. + --- ## Project Structure ``` codebrew.tech/ -โ”œโ”€โ”€ app/ # Next.js app directory -โ”‚ โ”œโ”€โ”€ page.tsx # Home page -โ”‚ โ”œโ”€โ”€ deck/ # Partnership deck -โ”‚ โ””โ”€โ”€ layout.tsx # Root layout -โ”œโ”€โ”€ components/ # React components -โ”‚ โ”œโ”€โ”€ globe.tsx # Interactive 3D globe -โ”‚ โ”œโ”€โ”€ footer.tsx # Footer component -โ”‚ โ””โ”€โ”€ ... -โ”œโ”€โ”€ public/ # Static assets -โ”œโ”€โ”€ lib/ # Utilities -โ””โ”€โ”€ scripts/ # Build scripts +โ”œโ”€โ”€ app/ # Next.js app directory +โ”‚ โ”œโ”€โ”€ page.tsx # Landing page with hero, stats, events +โ”‚ โ”œโ”€โ”€ deck/ # Partnership deck presentation +โ”‚ โ”‚ โ””โ”€โ”€ page.tsx # Interactive slide deck +โ”‚ โ”œโ”€โ”€ layout.tsx # Root layout with metadata +โ”‚ โ”œโ”€โ”€ globals.css # Global styles & design system +โ”‚ โ””โ”€โ”€ favicon.ico # Generated favicon +โ”œโ”€โ”€ components/ # React components +โ”‚ โ”œโ”€โ”€ globe.tsx # Interactive 3D globe (COBE) +โ”‚ โ”œโ”€โ”€ footer.tsx # Footer with link columns +โ”‚ โ”œโ”€โ”€ github-badge.tsx # Live GitHub star counter +โ”‚ โ””โ”€โ”€ logos/ # SVG logo components +โ”‚ โ”œโ”€โ”€ crafter-station.tsx +โ”‚ โ””โ”€โ”€ github.tsx +โ”œโ”€โ”€ lib/ +โ”‚ โ””โ”€โ”€ utils.ts # Tailwind class merge utility +โ”œโ”€โ”€ public/ # Static assets +โ”‚ โ”œโ”€โ”€ og.png # Open Graph image +โ”‚ โ”œโ”€โ”€ og-twitter.png # Twitter card image +โ”‚ โ””โ”€โ”€ *.svg # Icon assets +โ”œโ”€โ”€ scripts/ +โ”‚ โ””โ”€โ”€ generate-assets.ts # Brand asset generator +โ”œโ”€โ”€ package.json # Dependencies & scripts +โ”œโ”€โ”€ tsconfig.json # TypeScript configuration +โ”œโ”€โ”€ next.config.ts # Next.js configuration +โ”œโ”€โ”€ postcss.config.mjs # PostCSS with Tailwind +โ””โ”€โ”€ eslint.config.mjs # ESLint configuration ``` --- +## Design System + +Code Brew uses a custom brutalist design system with the following principles: + +### Color Palette +- **Void Black** (`#0A0A0A`) - Background +- **Signal Red** (`#D42B2B`) - Primary accent +- **Void White** (`#E5E5E5`) - Foreground text +- **Muted Gray** (`#6B6B6B`) - Secondary text +- **Border** (`#2A2A2A`) - Structural elements + +### Key Components +- **Grid Overlay** - Technical blueprint aesthetic +- **Corner Brackets** - Architectural framing +- **Diamond Markers** - Navigation & emphasis +- **Calibration Ticks** - Precision detail +- **Film Grain** - Analog texture +- **Ghost Text** - Large background typography + +### Typography +- **Headings**: Geist Sans (system font fallback) +- **Body & UI**: Geist Mono (monospace) +- Responsive sizing with clamp() +- Uppercase tracking for labels + +--- + ## Contributing We welcome contributions! If you'd like to improve the Code Brew website: @@ -131,24 +218,46 @@ We welcome contributions! If you'd like to improve the Code Brew website: --- -## Join the Community +## ๐Ÿค Join the Community + +
-- **Website**: [codebrew.tech](https://codebrew.tech) -- **Discord**: [crafters.chat](https://crafters.chat/) -- **GitHub**: [@crafter-station](https://github.com/crafter-station) +| Platform | Link | +|----------|------| +| ๐ŸŒ **Website** | [codebrew.tech](https://codebrew.tech) | +| ๐Ÿ’ฌ **Discord** | [crafters.chat](https://crafters.chat/) | +| ๐Ÿ™ **GitHub** | [@crafter-station](https://github.com/crafter-station) | +| ๐Ÿ“ฑ **WhatsApp** | [Contact us](https://wa.me/51912851377?text=Hi!%20I'm%20interested%20in%20Code%20Brew) | + +
--- -## Partnership +## ๐Ÿค Partnership + +Interested in sponsoring or partnering with Code Brew? -Interested in sponsoring or partnering with Code Brew? View our [partnership deck](/deck) or reach out through [crafters.chat](https://crafters.chat/). +- ๐ŸŽฏ View our [partnership deck](https://codebrew.tech/deck) +- ๐Ÿ’ผ Contact us via [WhatsApp](https://wa.me/51912851377?text=Hi!%20I'm%20interested%20in%20partnering%20with%20Code%20Brew) +- ๐Ÿ’ฌ Join the community at [crafters.chat](https://crafters.chat/) + +### Partnership Tiers +- **Venue Partner**: Host our monthly event with guaranteed foot traffic +- **Sponsor**: Logo placement across all event materials +- **Exclusive Partner**: Co-branding and deep community integration --- -## License +## ๐Ÿ“„ License This project is maintained by [Crafter Station](https://github.com/crafter-station). --- -**Est. 2024** ยท Built with care for the tech community +
+ +**Est. 2024** ยท Built with โค๏ธ for the tech community + +[๐Ÿ” Back to top](#code-brew) + +