shaynem

Personal Website

Welcome to my personal website! This is an MIT licensed React-based application. It offers a simple interface, easy modifications, static export capabilities and automatic deployments via GitHub Pages.

🚀 Features

• Built with modern JavaScript, using tools and frameworks like create-react-app, React-Router, and SCSS.
• Automated workflows via GitHub Actions.
• And more!

🔧 Dependencies

Ensure you have node >= v21 Optionally, use volta to manage node versions.

🚀 Setup and Running

1. Clone the repository:

   git clone https://api.github.com/repos/shaynem/shaynem.github.io
   cd shaynem.github.io
   

2. (Optional) Ensure you’re on Node v16 or higher:

   volta install node@21
   node --version
   

3. Install dependencies:

   yarn install
   

4. Start the application:

   yarn start
   

By default, the application should be available at http://localhost:3000/.

🚢 Deploying

Deploying to GitHub Pages

1. Update the environment variables and Git remote URL in .github/workflows/github-pages.yml.
2. Adjust the homepage value in package.json based on your hosting preferences.
3. Planning on using a custom domain? Update public/CNAME. Otherwise, remove it.

After initial commit to main, simply push your changes, and the deployment will be deployed by github actions automatically.

Static Export

For a static export without deploying to GitHub Pages:

• Remove or disable .github/workflows/github-pages.yml.

• Execute:

  yarn predeploy
  

This will generate a static version in shaynem.github.io/build/ which you can host or deploy to a CDN.

🙌 Acknowledgements

• Template from Future Imperfect
• create-react-app for the base React application.

This site is open source. Improve this page.