Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
b-smiley committed Aug 24, 2024
1 parent 285bdf3 commit f4d9db9
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Brendan Smiley's Portfolio Website
# Brendan Smiley's Portfolio Website and Blog

[brendansmiley.com](https://brendansmiley.com)

Expand All @@ -18,25 +18,31 @@ Created with [React GH Pages](https://github.com/gitname/react-gh-pages)
`npm install`
`npm start`

NOTE: Until future implementation, run the main website on port 3000 and the blog on port 3001
NOTE: Until future implementation, run the main website on port 3000 and the blog on port 3001. Custom scripts will help naviagte to the blog from the main website when developing locally.

# How to deploy

Manual Deploy - `npm run deploy`
GitHub Actions - Commit to Main branch for automatic deployment see [deploy.yml](.github/workflows/deploy.yml)

# Features

- [x] React GH Pages
- [x] 3D Model Viewer
- [x] Custom Domain
- [x] Docusaurus blog (using markdown)
- [x] GitHub Actions deployment

# Roadmap

- [x] Add a blog
- [ ] GitHub Actions deployment
- [ ] Add Google analytics
- [ ] Add a contact form
- [ ] Add a employment history section with a timeline

# NPM Packages Used

If you are looking to integrate any of these packages into your Github Page site, here is a list of some of the more challenges packages to integrate.
If you are looking to integrate any of these packages into your Github Page site, here is a list of some of the more challenges packages to integrate. This Github Page can be used as a reference.

- React
- Three.js
- Docusaurus
- React - with backspace navigation
- Three.js - 3D Model Viewer
- Docusaurus - Markdown Blog

0 comments on commit f4d9db9

Please sign in to comment.