|
1 | | -# Portfolio Website |
| 1 | +# 🧑💻 Portfolio Website |
2 | 2 |
|
3 | | -## Quick Start |
| 3 | +This is my personal developer portfolio built using **Next.js**, styled with **Tailwind CSS**, and integrated with a dynamic GitHub API backend. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## 🚀 Quick Start |
| 8 | + |
| 9 | +### 1. Clone & Install Dependencies |
4 | 10 |
|
5 | | -1. Clone and install: |
6 | 11 | ```bash |
7 | | -git clone https://github.com/amitminer/amitminer.github.io.git |
| 12 | +git clone [https://github.com/amitminer/amitminer.github.io.git](https://github.com/amitminer/amitminer.github.io.git) |
8 | 13 | cd amitminer.github.io |
9 | 14 | npm install |
10 | | -``` |
| 15 | +```` |
| 16 | + |
| 17 | +### 2\. Set Up Environment Variables |
| 18 | + |
| 19 | +Create the `.env.local` file: |
11 | 20 |
|
12 | | -2. Set up environment variables: |
13 | 21 | ```bash |
14 | 22 | cp .env.example .env.local |
15 | | -# Edit .env.local with your values: |
16 | | -# - NEXT_PUBLIC_BACKEND_URL: GitHub proxy backend API URL (e.g., http://localhost:8000/api/github) |
17 | | -# - NEXT_PUBLIC_FORMSPREE_FORM_ID: Get this from your Formspree form settings |
18 | 23 | ``` |
19 | 24 |
|
20 | | -3. Run development server: |
| 25 | +Then edit `.env.local` with your values: |
| 26 | + |
| 27 | +``` |
| 28 | +NEXT_PUBLIC_BACKEND_URL=[https://your-backend-domain.com/api/github](https://your-backend-domain.com/api/github) |
| 29 | +NEXT_PUBLIC_FORMSPREE_FORM_ID=your_formspree_id_here |
| 30 | +``` |
| 31 | +
|
| 32 | +----- |
| 33 | +
|
| 34 | +### 3\. Backend Setup (Required) |
| 35 | +
|
| 36 | +> 📦 GitHub Stats & Projects require a backend API. |
| 37 | +
|
| 38 | +To enable dynamic GitHub stats and repositories: |
| 39 | +
|
| 40 | +1. Clone the backend repo: |
| 41 | + 👉 https://github.com/amitxd75/github-api-backend |
| 42 | +
|
| 43 | +2. Follow its `README.md` to deploy it: |
| 44 | +
|
| 45 | + * Locally (for dev) |
| 46 | + * Or via Netlify Functions (recommended) |
| 47 | +
|
| 48 | +Once deployed, use that backend URL as `NEXT_PUBLIC_BACKEND_URL` in `.env.local`. |
| 49 | +
|
| 50 | +----- |
| 51 | +
|
| 52 | +### 4\. Run Development Server |
| 53 | +
|
21 | 54 | ```bash |
22 | 55 | npm run dev |
23 | 56 | ``` |
24 | 57 |
|
25 | | -Visit [http://localhost:3000](http://localhost:3000) to see your site. |
| 58 | +Visit your local site at: |
| 59 | +📍 http://localhost:3000 |
| 60 | + |
| 61 | +----- |
| 62 | + |
| 63 | +## 📡 API Backend |
26 | 64 |
|
27 | | -## Author |
| 65 | +Backend Repo → [github-api-backend](https://github.com/amitxd75/github-api-backend) |
| 66 | +Set it up properly, deploy to your server or Netlify, and configure `NEXT_PUBLIC_BACKEND_URL` in `.env.local`. |
28 | 67 |
|
29 | | -- **Amit** - [GitHub](https://github.com/amitminer) |
| 68 | +This enables real-time GitHub stats, repo data, and caching. |
0 commit comments