Zaplink Frontend - GDG CHARUSAT Open Source Contri Sprintathon

🎯 About This Project

Zaplink is an open-source project maintained by GDG CHARUSAT. This frontend is built with React, TypeScript, Vite, and Tailwind CSS, providing a modern and responsive user experience.

This repository is part of the GDG CHARUSAT Open Source Contri Sprintathon - a hands-on event designed to help students learn about open source contribution!

---

🚀 Quick Start for Contributors

Prerequisites

• Node.js (v18 or higher)
• npm
• Git

Installation

1. Fork this repository by clicking the "Fork" button at the top right

2. Clone your fork

   git clone https://github.com/YOUR-USERNAME/Zaplink_frontend.git
   cd Zaplink_frontend

3. Add upstream remote

   git remote add upstream https://github.com/gdg-charusat/Zaplink_frontend.git

4. Install dependencies

   npm install

5. Start development server

   npm run dev

The app will be running at http://localhost:5173 🎉

---

📚 Contributing

We welcome contributions from developers of all skill levels! Please read our CONTRIBUTING.md guide to get started.

Finding Issues

Browse our Issues page for tasks:

• Beginner 🟢: Look for good-first-issue or beginner labels
• Intermediate 🟡: Look for intermediate label

Contribution Workflow

1. Pick an issue and comment to get assigned
2. Create a new branch: git checkout -b feature/your-feature-name
3. Make your changes
4. Commit: git commit -m "feat: add feature description"
5. Push: git push origin feature/your-feature-name
6. Open a Pull Request

Need help? Check out our detailed CONTRIBUTING.md guide!

---

🛠 Tech Stack

• React 18 - UI library
• TypeScript - Type safety
• Vite - Build tool & dev server
• Tailwind CSS - Utility-first CSS
• Shadcn/ui - Component library

---

📁 Project Structure

Zaplink_frontend/
├── src/
│   ├── components/      # Reusable React components
│   ├── pages/          # Page components
│   ├── hooks/          # Custom React hooks
│   ├── utils/          # Helper functions
│   ├── types/          # TypeScript type definitions
│   ├── styles/         # Global styles
│   └── assets/         # Static assets (images, fonts)
├── public/             # Public static files
├── CONTRIBUTING.md     # Contribution guidelines
└── README.md           # This file

---

🧪 Available Scripts

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

# Run linter
npm run lint

---

🤝 Community

• Event: GDG CHARUSAT Open Source Contri Sprintathon
• Discord/WhatsApp: [Link to community group]
• Maintainers: [List maintainer GitHub usernames]

---

📜 Code of Conduct

Please read our Code of Conduct to understand the expected behavior in our community.

---

📝 License

[Add your license here]

---

🌟 Contributors

Thanks to all our amazing contributors!

---

📞 Need Help?

• 📖 Check the CONTRIBUTING.md guide
• 💬 Comment on the issue you're working on
• 🗣️ Ask in the event Discord/WhatsApp group
• 🐛 Found a bug? Create an issue

---

Happy Coding! 🚀

Made with ❤️ by GDG CHARUSAT