|
1 | 1 | # francisfuzz.com |
2 | 2 |
|
3 | | -`francisfuzz.com` is Francis' personal portfolio, built with **Next.js** and a library called [Nextra](https://nextra.vercel.app/). |
| 3 | +`francisfuzz.com` is Francis' personal portfolio, built with **Jekyll** and hosted on **GitHub Pages**. |
4 | 4 |
|
5 | | -## Instructions for local development |
| 5 | +## Deployment |
| 6 | + |
| 7 | +This site is configured to automatically deploy to GitHub Pages when you push to the `main` branch. GitHub Pages handles the Jekyll build process automatically. |
| 8 | + |
| 9 | +### Setting up GitHub Pages |
| 10 | + |
| 11 | +1. Go to your repository settings |
| 12 | +2. Navigate to Pages (under "Code and automation") |
| 13 | +3. Under "Build and deployment": |
| 14 | + - Source: Deploy from a branch |
| 15 | + - Branch: `main` / `/ (root)` |
| 16 | +4. Click Save |
| 17 | + |
| 18 | +GitHub will automatically build and deploy your site whenever you push changes. |
| 19 | + |
| 20 | +## Local Development |
| 21 | + |
| 22 | +### Using Docker (Recommended) |
| 23 | + |
| 24 | +The easiest way to run this site locally is using Docker: |
| 25 | + |
| 26 | +```shell |
| 27 | +# Build the Docker image: |
| 28 | +docker build -t francisfuzz-site . |
| 29 | + |
| 30 | +# Run the container: |
| 31 | +docker run -d --rm --name francisfuzz-site -p 4000:4000 -p 35729:35729 francisfuzz-site |
| 32 | + |
| 33 | +# View logs: |
| 34 | +docker logs -f francisfuzz-site |
| 35 | + |
| 36 | +# Stop the container: |
| 37 | +docker stop francisfuzz-site |
| 38 | +``` |
| 39 | + |
| 40 | +Then open your browser to http://localhost:4000 |
| 41 | + |
| 42 | +### Traditional local setup |
| 43 | + |
| 44 | +If you prefer to run Jekyll natively: |
6 | 45 |
|
7 | 46 | ```shell |
8 | 47 | # Clone this repository: |
9 | 48 | git clone https://github.com/francisfuzz/dotcom.git |
10 | 49 |
|
11 | | -# Change directory into this repository and install the dependencies using `npm`: |
| 50 | +# Change directory into this repository: |
12 | 51 | cd dotcom |
13 | | -npm install |
14 | 52 |
|
15 | | -# Run the server and open a new browser tab on where it's served up: `http://localhost:3000` |
16 | | -npm run dev |
| 53 | +# Install Ruby dependencies: |
| 54 | +bundle install |
| 55 | + |
| 56 | +# Run the Jekyll server: |
| 57 | +bundle exec jekyll serve |
| 58 | + |
| 59 | +# Open your browser to http://localhost:4000 |
17 | 60 | ``` |
18 | 61 |
|
| 62 | +**Note:** There may be compilation issues with the `eventmachine` gem on certain macOS versions. If you encounter errors, use the Docker approach above. |
| 63 | + |
19 | 64 | ## License |
20 | 65 |
|
21 | 66 | * Content: [Creative Commons, BY](http://creativecommons.org/licenses/by/3.0/) |
|
0 commit comments