Skip to content

CSE-TechClub/Club

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

🎓 Student Club Portal – Frontend (React)

Welcome to the official frontend for our Student Club Portal built with React + TypeScript. This is the UI part of our MUN stack setup for student engagement, quizzes, events, announcements, and more!


🚀 Tech Stack

  • React (with Vite)
  • TypeScript
  • Tailwind CSS
  • React Router
  • Lucide Icons
  • GitHub Actions (Planned)
  • MongoDB, Express, Node.js (Backend Coming Soon)

📁 Folder Structure

src/
├── components/      # Reusable components like Navbar, Footer
├── pages/           # Each route/page like Home, Members, Blogs
├── assets/          # Images and static files
├── App.tsx          # Main app component with routing
├── main.tsx         # Vite entry point
└── index.css        # Tailwind styles

🧑‍💻 Development Setup

  1. Clone the repo:

    git clone https://github.com/<your-club-account>/<repo-name>.git
  2. Install dependencies:

    npm install
  3. Run the development server:

    npm run dev
  4. Open http://localhost:5173 in your browser.


🧪 Contribution Flow (for club workflow)

🔁 This repo follows a fork → feature → PR → merge workflow.

  1. Fork this repository to your GitHub account.
  2. Create a new branch for your feature:
    git checkout -b feat/your-feature
  3. Push your changes:
    git push origin feat/your-feature
  4. Create a Pull Request from your fork to the main club repo.
  5. Get it reviewed and merged!

📣 Features

  • 💬 Club Announcements with Auto-Rotate & Pause on Hover
  • 🔗 Clickable Sub-Clubs with Dedicated Blog Pages
  • 🧠 Organized Structure for Members, Quizzes, Admin
  • 📊 Future Integration for Events and DB-driven content
  • 🔐 Backend Auth & Database logic (Coming soon via Node + MongoDB)

📦 Deployment

Hosted via GitHub Pages / Vercel / Netlify (choose one)

You can fork this repo, make changes, and deploy it easily on platforms like Vercel or Netlify


🙌 Maintainers

Built & Maintained by Club Tech Team
Lead Developer: Strom_Breaker_07
Contact: Mail


📃 License

MIT License © 2025 Students Club (cse)

About

This repository consist of the code of our club website

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7