/kay

Primary LanguageJavaScriptGNU Lesser General Public License v3.0LGPL-3.0


## Prerequisites 🍪

You should have Node.js and Git installed on your PC. You should also own a GitHub account.

Setup And Deployment 🔧

  1. To Get Started, Fork this repository to your GitHub account:

  2. Clone the forked repo from your account using:

      git clone https://github.com/<your-username>/home.git
  3. Open in editor and edit src/editable-stuff/config.js file.

  4. Add your resume as <resume.pdf> in place of src/editable-stuff/resume.pdf

  5. Edit title and meta description in public/index.html.

  6. Change URL in package.json file:

     "homepage": "https://<your-username>.github.io/home"

    Or for deployment at custom domain, refer create-react-app.dev

  7. After editing run the following bash commands:

    npm install
    npm start
  8. To deploy website, run:

     npm run build
     npm run deploy

    Or for deployment at <username>.github.io, refer READMEdocs/custom-deployment.md and pages.js

  9. Congrats your site is up and running. To see it live, visit:

      https://<your-username>.github.io/home
    
  10. To change the thumbnail image:

    • Navigate to the "public" folder.
    • There you will see "social-image.png".
    • Delete it.
    • Take a screenshot of your version and rename it "social-image.png" and place it there.

Next time if you make changes, repeat from step 8.