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