Merge pull request #2 from PowerInterviewAI/alpha/task1

Alpha/task1 - Initial Project Setup

Author: Power Interview

.env.example

@@ -0,0 +1,8 @@
+# API Configuration
+VITE_API_BASE_URL=https://api.example.com
+
+# Feature Flags
+VITE_ENABLE_ANALYTICS=false
+
+# Environment
+VITE_ENV=development

.github/workflows/deploy.yml

@@ -0,0 +1,51 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,41 +1,51 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.*
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/versions
-
-# testing
-/coverage
-
-# next.js
-/.next/
-/out/
-
-# production
-/build
-
-# misc
-.DS_Store
-*.pem
-
-# debug
+# Dependencies
+node_modules
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+
+# Build outputs
+dist
+dist-ssr
+build
+.vite
+*.local
+
+# Environment files
+.env
+.env.local
+.env.production
+.env.*.local
+
+# Logs
+logs
+*.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-.pnpm-debug.log*
+pnpm-debug.log*
+lerna-debug.log*
 
-# env files (can opt-in for committing if needed)
-.env*
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# Next.js (old)
+.next
+out
+next-env.d.ts
 
-# vercel
-.vercel
+# Testing
+coverage
+.nyc_output
 
-# typescript
+# Misc
 *.tsbuildinfo
-next-env.d.ts
+

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.npmrc

@@ -0,0 +1 @@
+legacy-peer-deps=true

.prettierignore

@@ -0,0 +1,23 @@
+# Dependencies
+node_modules
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+
+# Build outputs
+dist
+build
+.vite
+
+# Environment files
+.env
+.env.local
+.env.production
+
+# IDE
+.vscode
+.idea
+
+# OS
+.DS_Store
+Thumbs.db

.prettierrc

@@ -0,0 +1,23 @@
+{
+    "semi": true,
+    "trailingComma": "es5",
+    "singleQuote": true,
+    "printWidth": 100,
+    "tabWidth": 2,
+    "useTabs": false,
+    "arrowParens": "always",
+    "endOfLine": "lf",
+    "plugins": [
+        "@trivago/prettier-plugin-sort-imports",
+        "prettier-plugin-tailwindcss"
+    ],
+    "importOrder": [
+        "^react$",
+        "^react-dom$",
+        "<THIRD_PARTY_MODULES>",
+        "^@/(.*)$",
+        "^[./]"
+    ],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": true
+}

DEPLOYMENT.md

@@ -0,0 +1,90 @@
+# Deployment Guide
+
+## GitHub Pages Deployment
+
+This project is configured for automatic deployment to GitHub Pages using GitHub Actions.
+
+### Prerequisites
+
+1. A GitHub repository for this project
+2. GitHub Pages enabled in repository settings
+
+### Setup Steps
+
+1. **Push your code to GitHub:**
+
+   ```bash
+   git init
+   git add .
+   git commit -m "Initial commit: Vite + React + TypeScript setup"
+   git branch -M main
+   git remote add origin https://github.com/yourusername/power-interview-hero.git
+   git push -u origin main
+   ```
+
+2. **Enable GitHub Pages:**
+   - Go to your repository on GitHub
+   - Navigate to Settings → Pages
+   - Under "Build and deployment", select "GitHub Actions" as the source
+
+3. **Update base URL in vite.config.ts:**
+   - Change the `base` property to match your repository name:
+     ```typescript
+     base: '/your-repo-name/';
+     ```
+
+4. **Automatic Deployment:**
+   - The GitHub Actions workflow will automatically trigger on pushes to the `main` branch
+   - Check the "Actions" tab in your GitHub repository to monitor deployment progress
+   - Once complete, your site will be available at: `https://yourusername.github.io/your-repo-name/`
+
+### Manual Deployment
+
+If you prefer manual deployment:
+
+1. Build the project:
+
+   ```bash
+   npm run build
+   ```
+
+2. Deploy the `dist` folder to your hosting service
+
+### Environment Variables
+
+For production deployments, you can set environment variables:
+
+1. Create a `.env.production` file (not committed to git)
+2. Add your production environment variables:
+   ```
+   VITE_API_BASE_URL=https://production-api.example.com
+   VITE_ENABLE_ANALYTICS=true
+   ```
+
+### Custom Domain (Optional)
+
+To use a custom domain with GitHub Pages:
+
+1. Add a `CNAME` file to the `public` folder with your domain name
+2. Configure your DNS provider to point to GitHub Pages
+3. Enable "Enforce HTTPS" in GitHub Pages settings
+
+## Other Hosting Options
+
+### Vercel
+
+```bash
+npm install -g vercel
+vercel
+```
+
+### Netlify
+
+```bash
+npm install -g netlify-cli
+netlify deploy --prod
+```
+
+### Traditional Web Server
+
+Simply upload the contents of the `dist` folder to your web server's public directory.