Building your own personal website from this project can take as little as 30 minutes. Follow the setup instructions below and review detailed notes and a checklist on adapting this project here. Please feel free to reach out to me by filing an issue or emailing me at [email protected] for help configuring your project.
Contributions are actively encouraged. Please review the design goals, roadmap, and contributing guidelines. If you find a bug, please email me, submit a pull request (I'll buy you a coffee as a thank you), or submit an issue.
To download the repository and install dependencies, run the following commands:
git clone git://github.com/mldangelo/personal-site.git # replace [mldangelo] with your github username if you fork first. cd personal-site nvm install # this is optional - make sure you're running >= node 12 with `node --version` npm install
Run the following command to build the react application and serve it with fast refresh:
Your web browser should automatically open to
<ip>:<port>:<path> default: http://localhost:3000/.
package.jsonto point to where you plan to host your site. If you do not plan on using a custom domain name, it should look like
https://[your-gh-username].github.io/[repository-name - default:personal-site]/
public/CNAME. If you don't, delete
Make a commit to
main and push your changes. That's it.
To statically export the site without deploying to github pages, delete or disable
.github/workflows/github-pages.yml and run
npm run predeploy. This generates a static export of the website as
personal-site/build/. Copy this and self-host or deploy to a CDN.