Induction Website

Visit Live Website »

Report Bug · Request Feature

Table of Contents

• Development
  • Libraries/Frameworks Used
  • File Structure
  • Setting Up Locally
• Contact
• Acknowledgements
• Additional Documentation

Development

Libraries/Frameworks Used

This project has been built with the following technologies.

• React 18
• Vite
• Tailwind CSS
• TypeScript
• React Router DOM
• shadcn/ui (Radix UI)
• TanStack React Query
• Lucide React (Icons)

File Structure

.
├── public/          # Static assets & public resources
├── src/
│   ├── assets/      # Image and media assets
│   ├── components/  # Reusable React components (FAQ, Schedule, Map, etc.)
│   │   └── ui/      # shadcn/ui design system primitives
│   ├── hooks/       # Custom React hooks (e.g., use-mobile)
│   ├── lib/         # Utility/helper functions (e.g., cn)
│   ├── pages/       # Page-level view components (Index, NotFound)
│   ├── App.css      # App-level styling
│   ├── App.tsx      # Main application routing and structure
│   ├── index.css    # Tailwind CSS and global style system
│   └── main.tsx     # Application entry point
├── components.json  # shadcn/ui configuration
├── eslint.config.js # ESLint rules and settings
├── index.html       # HTML entry point template
├── package.json     # Project dependencies & scripts
├── postcss.config.js # PostCSS configuration
├── tailwind.config.ts # Tailwind CSS configuration
├── tsconfig.json    # TypeScript configuration
└── vite.config.ts   # Vite bundler configuration

• public: Contains static files such as logos, icons, and fonts.
• src: Contains all React/TypeScript source code.
  • assets: Image assets (backgrounds, photos, etc.) used within components.
  • components: Core website components, custom sections, and shadcn UI elements.
  • hooks: Reusable UI state hooks.
  • lib: Common utility functions.
  • pages: Main pages mapped to routes.

Setting Up Locally

Prerequisites: Node.js v18+ and npm (bundled with Node.js).

# Clone the repository
git clone https://github.com/tsg-iitkgp/freshers-induction.git
cd freshers-induction

# Install dependencies
npm install

# Start the development server
npm run dev

The site will be available at http://localhost:5173.

Available Scripts

Command	Description
npm run dev	Start Vite dev server
npm run build	Create a production build
npm run build:dev	Create a development-mode production build
npm run lint	Run ESLint checks
npm run preview	Preview the production build locally

(back to top)

Contact

Note

For any ideas, suggestions or queries regarding the website, mail us at tech.coordi@iitkgp.ac.in

Present Technology Coordinator(s)

Name	Email	Phone No.
Harsh Raj Dubey	dubeyharshraj.iitkgp@gmail.com	+91-9636402605
Shubham Krishan	shubhamkrishan.iitkgp@gmail.com	+91-7812083803

(back to top)

Acknowledgements

• Img Shields
• Technology Students' Gymkhana (TSG), IIT Kharagpur

(back to top)

Additional Documentation

• Changelogs
• License
• Security Policy
• Code of Conduct
• Contribution Guidelines

(back to top)