From e9329cf7d7710832be11a1eb5ebb29d3cecaf7f4 Mon Sep 17 00:00:00 2001 From: "opencode-agent[bot]" Date: Fri, 6 Feb 2026 01:51:54 -0500 Subject: [PATCH] docs: update README.md with comprehensive project information - Replace generic Next.js boilerplate with Code Brew specific content - Add project description, mission, and stats - Include list of active and upcoming cities - Document tech stack and project structure - Add design system overview - Include community and partnership links - Improve getting started and development instructions --- README.md | 147 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 129 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e215bc4..388db5a 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,147 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). +# Code Brew -## Getting Started +[![Website](https://img.shields.io/badge/Website-codebrew.tech-blue)](https://codebrew.tech) +[![Community](https://img.shields.io/badge/Community-crafters.chat-green)](https://crafters.chat) -First, run the development server: +**Code Brew** is a monthly tech meetup series organized by [Crafter Station](https://github.com/crafter-station) that brings together software engineers, designers, founders, and tech professionals across Latin America and Spain to connect, share knowledge, and build relationships. + +## 🌎 About + +Building Latin America's most engaged tech community, one coffee at a time. From Lima to Madrid, Bogota to Buenos Aires — we're creating spaces where the tech community can thrive over coffee and conversation. + +### Mission + +- **Connect**: Bridge the gap between tech professionals across Latin America and beyond +- **Share**: Create spaces for knowledge exchange, mentorship, and collaborative learning +- **Build**: Foster lasting relationships that turn into projects, companies, and friendships + +## 📍 Cities + +We're currently hosting events in: + +- 🇵🇪 **Lima, Peru** (Active) +- 🇨🇴 **Bogota, Colombia** (Active) +- 🇪🇸 **Madrid, Spain** (Active) +- 🇧🇷 **Sao Paulo, Brazil** (Coming Soon) +- 🇦🇷 **Buenos Aires, Argentina** (Coming Soon) + +## 📊 Stats + +- **06** Events Hosted +- **05** Countries & Growing +- **100+** Attendees + +## 🚀 Getting Started + +This website is built with [Next.js 16](https://nextjs.org), [React 19](https://react.dev), and [Tailwind CSS 4](https://tailwindcss.com). + +### Prerequisites + +- Node.js 20+ or Bun +- npm, yarn, pnpm, or bun + +### Installation ```bash -npm run dev +# Clone the repository +git clone https://github.com/crafter-station/codebrew.tech.git +cd codebrew.tech + +# Install dependencies +bun install +# or +npm install +``` + +### Development + +```bash +# Start the development server +bun dev # or -yarn dev +npm run dev +``` + +Open [http://localhost:3000](http://localhost:3000) to see the website. + +### Build + +```bash +# Create a production build +bun run build # or -pnpm dev +npm run build + +# Start the production server +bun start # or -bun dev +npm start ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## 🛠️ Tech Stack + +- **Framework**: Next.js 16 with App Router +- **Language**: TypeScript +- **Styling**: Tailwind CSS 4 +- **UI Components**: Custom components with Lucide React icons +- **Animations**: Motion (Framer Motion) +- **3D Globe**: COBE +- **Analytics**: Vercel Analytics +- **Font**: Geist Sans & Geist Mono + +## 📁 Project Structure + +``` +codebrew.tech/ +├── app/ # Next.js app directory +│ ├── deck/ # Partnership deck page +│ ├── layout.tsx # Root layout with metadata +│ ├── page.tsx # Home page +│ └── globals.css # Global styles and design system +├── components/ # React components +│ ├── footer.tsx # Footer component +│ ├── github-badge.tsx # GitHub badge component +│ ├── globe.tsx # 3D globe visualization +│ └── logos/ # Logo components +├── lib/ # Utility functions +├── public/ # Static assets +└── scripts/ # Build and utility scripts +``` + +## 🎨 Design System + +The project features a custom brutalist/technical design system with: + +- Monospace typography (Geist Mono) +- Bordered layouts with corner brackets +- Grid overlays and film grain effects +- Signal color accents (#00ff00) +- Calibration marks and decorative elements +- Responsive breakpoints for mobile and desktop + +## 🤝 Contributing + +We welcome contributions! Whether it's: -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +- Reporting bugs +- Suggesting new features +- Improving documentation +- Submitting pull requests -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. +Please feel free to open an issue or submit a PR. -## Learn More +## 🔗 Links -To learn more about Next.js, take a look at the following resources: +- **Website**: [codebrew.tech](https://codebrew.tech) +- **Community**: [crafters.chat](https://crafters.chat) +- **Organization**: [Crafter Station](https://github.com/crafter-station) -- [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. +## 📄 License -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! +This project is maintained by Crafter Station. See the repository for license details. -## Deploy on Vercel +## 🌟 Join the Community -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. +Want to attend an event or become a partner? Visit our website or join our community chat to get involved! -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +[Join the Community](https://crafters.chat) • [View Partnership Deck](https://codebrew.tech/deck)