A modern, lightweight web app starter built with React + Vite + Tailwind CSS ✨
RoomKey is designed to be a clean, fast, and customizable frontend project. Whether you’re building a room booking system, a college project, or just experimenting with modern web dev tools, this template gives you a head start.
✅ Blazing fast development with Vite
✅ Utility-first styling powered by Tailwind CSS
✅ Component-based architecture with React
✅ Code linting & quality with ESLint
✅ Optimized production build in seconds
✅ Ready-to-extend public & src structure
| Category | Tools / Frameworks |
|---|---|
| ⚛️ Frontend | React 18, JSX |
| ⚡ Bundler | Vite |
| 🎨 Styling | Tailwind CSS, PostCSS |
| 🧹 Linting | ESLint |
| ⚙️ Config | Vite, Tailwind, PostCSS, ESLint |
RoomKey/
├── public/ # Static assets
├── src/ # Application source code
│ ├── components/ # Reusable React components
│ ├── App.jsx # Main app component
│ ├── main.jsx # Entry point
│ └── index.css # Global styles
├── .env # Environment variables
├── vite.config.js # Vite configuration
├── tailwind.config.js # Tailwind configuration
├── postcss.config.cjs # PostCSS config
├── eslint.config.js # ESLint rules
└── package.json # Dependencies & scripts
Follow these steps to run RoomKey locally:
# 1. Clone the repo
git clone https://github.com/S-Nitya/RoomKey.git
cd RoomKey
# 2. Install dependencies
npm install
# 3. Start development server
npm run dev👉 The app will run at http://localhost:5173/
To build for production:
npm run build
npm run preview- Edit
tailwind.config.jsto tweak theme colors, fonts, breakpoints. - Add environment variables inside
.env(don’t commit sensitive keys!). - Extend components in
src/components/for new features/pages.
- 🔗 Add React Router for navigation
- 🧪 Setup testing with Jest/Vitest
- 📸 Include screenshots / demo GIFs
- ⚡ Deploy on Vercel / Netlify for instant live demo
Developed by Nitya Singh & Siddhi Sushir