Technology Stack

Dependencies defined in package.json:

Reactjs | Bootstrap | Typist | GitHub API | Instagram API

Sharing

Project is open source, and was based on work by @hashirshoaeb that can be found here.

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/configurations.json file.

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

5. Change URL in package.json file:

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

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

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

7. After editing run the following bash commands:

   npm install
   npm start

8. To deploy website run:

    npm run build

    yarn add --dev gh-pages

    yarn run deploy

   For custom deployment, refer pages.js

    npm run custom-deploy

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

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

License

LGPL-3.0