A performant, accessible, progressive React portfolio template that uses the GitHub REST API.
Add your GitHub username once and all of your info will automatically be updated. Deploy to GitHub pages in a few simple steps.
Open your project and install the dependencies
npm install
Add your GitHub username (src/config.js line 18)
/* START HERE
**************************************************************
Add your GitHub username (string - "YourUsername") below.
*/
export const githubUsername = "Your GitHub username here";
Start the development server to view the results
npm start
The contact form uses Formspree, create an account and add your endpoint URL (src/config.js line 114)
/* Contact Info
**************************************************************
Add your formspree endpoint below.
https://formspree.io/
*/
export const formspreeUrl = "https://formspree.io/f/YourEndpoint";
A helpful guide for Create React App deployments with GitHub Pages can be found here.
Update the homepage value (package.json line 3)
"homepage": "https://YourUserName.github.io/your-repo/",
Run the deploy command
npm run deploy
Checkout the Wiki for additional customization options: