README.md

Portfolio

Objective

Creating Portfolio

Maintainer

Name	NUID
Naresh Agrawal	001054600

Technology Stack

• React
• GitHub API
• GitHub pages

Prerequisites

• React
• npm

Setup And Deployment

1. Clone the repository

     https://github.com/nareshagrawal/nareshagrawal.github.io.git

2. Open in editor and edit src/editable-stuff/config.js file.

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

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

5. Change URL in package.json file:

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

6. After editing run the following bash commands to run website locally:

   $ npm install
   $ npm start

7. To deploy website:

   • Create repository of name <github-username>.github.io
   • Copy source code to <github-username>.github.io repository

    $ npm run build
    $ npm run deploy

   Or for deployment at <github-username>.github.io, refer pages.js

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

     https://<github-username>.github.io/home
   

9. 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 6.