diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..be1ad28 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,38 @@ +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: false + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: '.' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md new file mode 100644 index 0000000..0ddaeb7 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# Portfolio Website + +A personal portfolio website for Mayank Joshi showcasing ML development projects, blog posts, and professional experience. + +## 🚀 Publishing to GitHub Pages + +This repository is configured to automatically deploy to GitHub Pages using GitHub Actions. + +### Setup Instructions + +1. **Enable GitHub Pages:** + - Go to your repository settings + - Navigate to "Pages" in the left sidebar + - Under "Build and deployment", set: + - Source: **GitHub Actions** + +2. **Deployment:** + - The site will automatically deploy when you push to the `main` branch + - You can also manually trigger deployment from the "Actions" tab + +3. **Access Your Site:** + - Once deployed, your site will be available at: `https://lothnic.github.io/portfolio/` + - If you want this to be your main user page (`https://lothnic.github.io`), rename this repository to `lothnic.github.io` + +### Manual Deployment + +You can manually trigger a deployment by: +1. Going to the "Actions" tab in your repository +2. Selecting "Deploy to GitHub Pages" workflow +3. Clicking "Run workflow" + +## 📁 Project Structure + +``` +. +├── index.html # Main portfolio page +├── styles.css # Styles +├── script.js # JavaScript functionality +├── blog/ # Blog section +├── images/ # Image assets +├── resume/ # Resume files +└── resume.pdf # PDF resume +``` + +## 🛠️ Local Development + +Since this is a static HTML site, you can simply open `index.html` in your browser, or use a local server: + +```bash +# Using Python +python -m http.server 8000 + +# Using Node.js +npx serve + +# Using PHP +php -S localhost:8000 +``` + +Then visit `http://localhost:8000` + +## 📝 License + +This is a personal portfolio project.