React Porfolio

mason.zarns.net

Table of Contents

1. About
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Acknowledgments

About

Currently working on integrating a chess game into the site.

Built With

Getting Started

To get your own portfolio up and running follow these steps.

Prerequisites

1. Install NodeJS

   https://nodejs.org

2. Install NPM & Yarn

   npm install npm@latest -g

   npm install --global yarn

3. Install gh-pages

   npm install gh-pages --save-dev

4. Probably some other things I forgot along the way 😉

Installation

1. Clone the repo

   git clone https://github.com/zarns/portfolio.git

2. Setup yarn environment

   yarn add next

   yarn install

3. Run locally on port 3000

   yarn dev

   • Open http://localhost:3000/ in browser
   • Edit a file and save. Watch changes deploy locally in seconds. Start with src/data/data.tsx

4. Github Actions

   • Upon pushing to the main branch, the script: .github/workflows/nextjs.yml will automatically run in Github Actions (you can check progress in the Actions section of your repo) This should automatically install dependencies, build the project, and deploy the server! 😇
   • Check in your Github Pages settings that the app is being deployed from the main branch and root directory.
   • Github Pages provides a domain. If you want to use a custom domain: using-custom-domains-for-react-apps-deployed-to-github-pages

Acknowledgments

I went into this project with limited frontend experience and followed a number of tutorials before feeling comfortable enough to pull ideas from different places. Major thanks to these resources:

• braydoncoyer-porfolio
• soumyajit-porfolio
• ariful-gitprofile
• portfolio-v2
• react-resume
• leerob.io
• readme-template
• GitHub Emoji Cheat Sheet
• Image Shields
• GitHub Pages
• React Icons
• Hero Icons

(back to top)