From 3bed4ef91905a8c14108e12aeb8b697cd15ce673 Mon Sep 17 00:00:00 2001 From: "opencode-agent[bot]" Date: Fri, 6 Feb 2026 01:13:04 -0500 Subject: [PATCH] docs: update README with project-specific information --- README.md | 79 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 61 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e215bc4..995872c 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,79 @@ -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 + +The official website for Code Brew — monthly tech meetups where software engineers, designers, founders, and tech professionals gather across Latin America and Spain to connect, share knowledge, and build relationships. + +## About + +Code Brew is building Latin America's most engaged tech community, one coffee at a time. We host regular meetups in multiple cities, fostering connections and knowledge sharing among tech professionals. + +### Active Cities +- Lima, Peru +- Bogota, Colombia +- Madrid, Spain + +### Coming Soon +- Sao Paulo, Brazil +- Buenos Aires, Argentina + +## Tech Stack + +This project is built with: +- [Next.js 16](https://nextjs.org) - React framework +- [React 19](https://react.dev) - UI library +- [TypeScript](https://www.typescriptlang.org) - Type safety +- [Tailwind CSS v4](https://tailwindcss.com) - Styling +- [Motion](https://motion.dev) - Animations +- [Lucide React](https://lucide.dev) - Icons +- [Cobe](https://github.com/shuding/cobe) - 3D Globe visualization +- [Vercel Analytics](https://vercel.com/analytics) - Analytics ## Getting Started -First, run the development server: +First, install dependencies: + +```bash +bun install +``` + +Then, run the development server: ```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or bun dev ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +## Project Structure + +``` +├── app/ +│ ├── page.tsx # Main landing page +│ ├── layout.tsx # Root layout with metadata +│ └── globals.css # Global styles +├── components/ +│ ├── footer.tsx # Footer component +│ ├── github-badge.tsx # GitHub badge component +│ ├── globe.tsx # 3D Globe component +│ └── logos/ # Logo components +├── public/ # Static assets +└── lib/ # Utility functions +``` -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. +## Scripts -## Learn More +- `bun dev` - Start development server +- `bun build` - Build for production +- `bun start` - Start production server +- `bun lint` - Run ESLint -To learn more about Next.js, take a look at the following resources: +## Contributing -- [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. +Contributions are welcome! Please feel free to submit a Pull Request. -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! +## License -## Deploy on Vercel +This project is private and proprietary. -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. +## Connect -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +Visit [codebrew.tech](https://codebrew.tech) to learn more and join our next meetup!