|
| 1 | +# Interview Ready Gems 💎 |
| 2 | + |
| 3 | +A powerhouse suite of companion apps built to enhance **Interview Ready** experience. Each feature is crafted to help developers train smarter, assess better, and optimize their workflow—ensuring they stand out and get hired faster. |
| 4 | + |
| 5 | +## 🚀 About This Repository |
| 6 | + |
| 7 | +This is a **Next.js** project designed with a **modular architecture** to support multiple features, such as **Resume Checker** and **Take Home Checker**. Each feature is encapsulated within its own directory, ensuring better maintainability and scalability. |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +## 🚀 Features |
| 12 | + |
| 13 | +- **Resume Checker**: A tool for analyzing and reviewing resumes. |
| 14 | +- **Take Home Checker**: A tool to assess take-home assignments. |
| 15 | + |
| 16 | + |
| 17 | +## 📁 Project Structure |
| 18 | + |
| 19 | +``` |
| 20 | +/src/ |
| 21 | + /features/ |
| 22 | + /resume-checker/ # Feature: Resume Checker |
| 23 | + /components/ # Specific UI components |
| 24 | + /hooks/ # Custom hooks for this feature |
| 25 | + /services/ # API calls and business logic |
| 26 | + /pages/ # Next.js pages (entry point for this feature) |
| 27 | + index.tsx # /resume-checker route |
| 28 | + /take-home-checker/ # Feature: Take Home Checker |
| 29 | + /components/ |
| 30 | + /hooks/ |
| 31 | + /services/ |
| 32 | + /pages/ |
| 33 | + index.tsx # /take-home-checker route |
| 34 | + /components/ # Shared UI components across features |
| 35 | + /hooks/ # Shared hooks |
| 36 | + /services/ # Shared business logic |
| 37 | + /pages/ # Next.js pages |
| 38 | + index.tsx # Main entry point |
| 39 | + /styles/ # Global styles |
| 40 | + /public/ # Static assets |
| 41 | + next.config.js |
| 42 | + tsconfig.json |
| 43 | + package.json |
| 44 | +``` |
| 45 | + |
| 46 | +## 🚀 Getting Started |
| 47 | + |
| 48 | +### 1️⃣ Install Dependencies |
| 49 | + |
| 50 | +```bash |
| 51 | +npm install # or yarn install or pnpm install |
| 52 | +``` |
| 53 | + |
| 54 | +### 2️⃣ Run Development Server |
| 55 | + |
| 56 | +```bash |
| 57 | +npm run dev # or yarn dev or pnpm dev |
| 58 | +``` |
| 59 | + |
| 60 | +Open [http://localhost:3000](http://localhost:3000) in your browser to see the result. |
| 61 | + |
| 62 | +### 3️⃣ Run Production Build |
| 63 | + |
| 64 | +```bash |
| 65 | +npm run build |
| 66 | +npm start |
| 67 | +``` |
| 68 | + |
| 69 | +## 🏗️ Architectural Decisions |
| 70 | + |
| 71 | +### 1️⃣ **Encapsulation per Feature** |
| 72 | +Each feature has its own `/pages/` directory inside `/src/features/`. This structure keeps feature-specific code self-contained while still allowing for shared utilities. |
| 73 | + |
| 74 | +### 2️⃣ **Page Router Approach** |
| 75 | +We opted for **Next.js Pages Router** instead of App Router for simplicity and compatibility with traditional routing patterns. |
| 76 | + |
| 77 | +### 3️⃣ **Shared Components & Services** |
| 78 | +Common UI elements and business logic reside in `/src/components/` and `/src/services/`, preventing code duplication. |
| 79 | + |
| 80 | +### 4️⃣ **Flexible Styling** |
| 81 | +- **Tailwind CSS** is the primary styling approach. |
| 82 | +- **CSS-in-JS (Styled Components, Emotion, etc.)** can be used per feature, ensuring flexibility without enforcing a single styling method. |
| 83 | + |
| 84 | +## 🚀 Deploying on Vercel |
| 85 | + |
| 86 | +This project is optimized for deployment on **Vercel**. To deploy: |
| 87 | + |
| 88 | +1. Push your code to a GitHub repository. |
| 89 | +2. Connect the repository to [Vercel](https://vercel.com/). |
| 90 | +3. Vercel will automatically build and deploy the app. |
| 91 | + |
| 92 | +For manual deployment: |
| 93 | + |
| 94 | +```bash |
| 95 | +vercel |
| 96 | +``` |
| 97 | + |
| 98 | +## 📖 Additional Resources |
| 99 | + |
| 100 | +- [Next.js Documentation](https://nextjs.org/docs) |
| 101 | +- [Vercel Deployment Guide](https://nextjs.org/docs/pages/building-your-application/deploying) |
| 102 | + |
| 103 | +--- |
| 104 | + |
| 105 | +This project is designed to be **scalable, maintainable, and easy to extend**. Contributions and improvements are always welcome! 🚀 |
| 106 | + |
0 commit comments