|
| 1 | +# Instructions 1: GitHub Repository Setup and Deployment |
| 2 | + |
| 3 | +This document provides step-by-step instructions for uploading the HelloEmily.dev website to GitHub and configuring GitHub Pages for deployment. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | +1. Git installed and configured on your local machine |
| 7 | +2. GitHub account (emscape) with access to create repositories |
| 8 | +3. Proper permissions to modify DNS settings for HelloEmily.dev domain |
| 9 | + |
| 10 | +## Step 1: Create GitHub Repository |
| 11 | +1. Log in to GitHub (emscape account) |
| 12 | +2. Click "New repository" button |
| 13 | +3. Name the repository "HelloEmilyDev" |
| 14 | +4. Set visibility to Public (for GitHub Pages) |
| 15 | +5. Do not initialize with README, .gitignore, or license |
| 16 | +6. Click "Create repository" |
| 17 | + |
| 18 | +## Step 2: Configure Git (if not already configured) |
| 19 | +1. Set your Git username: |
| 20 | + ``` |
| 21 | + git config --global user.name "emscape" |
| 22 | + ``` |
| 23 | +2. Set your Git email: |
| 24 | + ``` |
| 25 | + git config --global user.email "emily@theDapperFoxes.com" |
| 26 | + ``` |
| 27 | + |
| 28 | +## Step 3: Connect Local Repository to GitHub |
| 29 | +1. Open terminal/command prompt in the local repository directory |
| 30 | +2. Run: `git remote add origin https://github.com/emscape/HelloEmilyDev.git` |
| 31 | +3. Verify connection with: `git remote -v` |
| 32 | + |
| 33 | +## Step 4: Push Local Repository to GitHub |
| 34 | +1. Ensure all changes are committed locally |
| 35 | + - `git add .` |
| 36 | + - `git commit -m "Initial commit of HelloEmily.dev website"` |
| 37 | +2. Push to GitHub: |
| 38 | + - `git push -u origin main` |
| 39 | + |
| 40 | +## Step 5: Configure GitHub Pages |
| 41 | +1. Go to repository settings on GitHub |
| 42 | +2. Navigate to "Pages" section |
| 43 | +3. Set source to "Deploy from a branch" |
| 44 | +4. Select "main" branch and "/ (root)" folder |
| 45 | +5. Click "Save" |
| 46 | +6. Under "Custom domain", enter "HelloEmily.dev" |
| 47 | +7. Check "Enforce HTTPS" option |
| 48 | + |
| 49 | +## Step 6: Verify DNS Configuration |
| 50 | +1. Ensure A records point to GitHub Pages IP addresses: |
| 51 | + - 185.199.108.153 |
| 52 | + - 185.199.109.153 |
| 53 | + - 185.199.110.153 |
| 54 | + - 185.199.111.153 |
| 55 | +2. Ensure CNAME record for www.HelloEmily.dev points to emscape.github.io |
| 56 | + |
| 57 | +## Step 7: Test Website |
| 58 | +1. Wait for DNS propagation (may take up to 24 hours) |
| 59 | +2. Visit HelloEmily.dev to verify the website is working |
| 60 | +3. Check that HTTPS is working properly |
| 61 | + |
| 62 | +## Troubleshooting |
| 63 | +- If GitHub Pages doesn't build, check the Actions tab for error messages |
| 64 | +- If DNS isn't working, verify DNS settings with your domain provider |
| 65 | +- If HTTPS isn't working, ensure "Enforce HTTPS" is checked in GitHub Pages settings |
| 66 | + |
| 67 | +## Command Reference |
| 68 | +```bash |
| 69 | +# Configure Git |
| 70 | +git config --global user.name "emscape" |
| 71 | +git config --global user.email "emily@theDapperFoxes.com" |
| 72 | + |
| 73 | +# Connect to GitHub remote |
| 74 | +git remote add origin https://github.com/emscape/HelloEmilyDev.git |
| 75 | + |
| 76 | +# Verify remote connection |
| 77 | +git remote -v |
| 78 | + |
| 79 | +# Stage all files |
| 80 | +git add . |
| 81 | + |
| 82 | +# Commit changes |
| 83 | +git commit -m "Initial commit of HelloEmily.dev website" |
| 84 | + |
| 85 | +# Push to GitHub |
| 86 | +git push -u origin main |
| 87 | +``` |
| 88 | + |
| 89 | +## Completed Actions |
| 90 | +- ✅ Git global configuration set |
| 91 | +- ✅ Remote repository added |
| 92 | +- ✅ Files staged and committed |
| 93 | +- ✅ Repository pushed to GitHub |
0 commit comments