Skip to content

gdgoc-usls/event

Repository files navigation

GDGOC USLS Events and Projects

Google Developer Groups on Campus USLS Events and projects website built with Next.js, React, and Tailwind CSS.

✨ Contributing

If you like this project, please consider giving it a star! ⭐

If you wish to suggest improvements or work on new features, please open an issue to leeyam.dev@gmail.com. We appreciate your interest and look forward to collaborating with you!

🛠️ Tech Stack

  • Framework: Next.js 14 with App Router
  • Language: TypeScript
  • Styling: Tailwind CSS
  • UI Components: shadcn/ui
  • Icons: Lucide React
  • Deployment: Vercel

📋 Prerequisites

  • Node.js >= 18 or nvm
  • pnpm >= 8 (recommended) or npm/yarn

🚀 Install Dependencies

If you're using nvm, you can easily switch to the required Node.js version:

$ nvm use 18 # ignore if you're already on Node.js >= 18
$ pnpm install

🏃‍♂️ Development Server

Start the development server:

$ pnpm dev
# or
$ npm run dev
# or
$ yarn dev

Open http://localhost:3000 in your browser to see the result.

🏗️ Building for Production

After making changes, run a build to check for lint and type errors:

$ pnpm build
# or
$ npm run build

To start the production server:

$ pnpm start
# or
$ npm run start

Styling Guidelines

  • Use Tailwind CSS utility classes
  • Follow desktop-first responsive design
  • Maintain consistent spacing and typography

Theme Configuration

The project includes comprehensive theme support:

  • Light/dark mode toggle
  • System preference detection
  • Persistent theme selection
  • CSS custom properties for colors

🚀 Deployment

Vercel (Recommended)

  1. Push your code to GitHub/GitLab/Bitbucket
  2. Connect your repository to Vercel
  3. Vercel will automatically deploy on every push

Other Platforms

This project can be deployed to:

  • Netlify
  • Vercel

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests and linting (pnpm build)
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Once ready, you can submit a pull request for review.

📄 License

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


Built with ❤️ using Next.js, React, and Tailwind CSS


Releases

No releases published

Packages

No packages published