Skip to content

Commit

Permalink
Merge pull request #4 from gmickel:clarify-pages-deployment
Browse files Browse the repository at this point in the history
chore: update README, clarify gh pages deployment
  • Loading branch information
gmickel authored Jul 19, 2024
2 parents c6f4699 + 48060d8 commit 07b9f69
Showing 1 changed file with 33 additions and 7 deletions.
40 changes: 33 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,16 +111,42 @@ Remember, with great power comes great responsibility. Use these features wisely

## 🌐 Deploying Your Quest to the World (aka. GitHub Pages)

1. Push your changes to GitHub. (Don't forget to `git add .` and `git commit -m "Made my quiz awesome"`)
## Deployment Steps

2. Go to your repository settings, find the "Pages" section, and set the source to the `gh-pages` branch.
1. Push your changes to GitHub:

3. Run the deployment spell:
```
bun run deploy
```
```bash
git add .
git commit -m "Made my quiz awesome"
git push
```

2. Go to your repository settings on GitHub, find the "Pages" section.

3. Under "Source", select "GitHub Actions" instead of a branch.

4. Modify your `vite.config.ts` file to include the correct base path:

```typescript
export default defineConfig({
// ... other config options
base: '/your-repo-name/', // Replace with your actual repository name
});
```

5. Commit these changes and push to GitHub:

```bash
git add vite.config.ts
git commit -m "Configure GitHub Actions deployment"
git push
```

6. GitHub Actions will now automatically build and deploy your site when you push to the main branch.

8. Watch in awe as your quiz magically appears at `https://yourusername.github.io/ypir-repo-name/`!

4. Watch in awe as your quiz magically appears at `https://yourusername.github.io/codequest`!
**Note**: The first deployment might take a few minutes. You can check the progress in the "Actions" tab of your GitHub repository.

## 🤝 Contributing (Because Teamwork Makes the Dream Work)

Expand Down

0 comments on commit 07b9f69

Please sign in to comment.