Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 2.7 KB

README.md

File metadata and controls

83 lines (58 loc) · 2.7 KB

Quick Project Setup

  1. Clone the repository to your local machine
  2. Run npm install and wait for installation to complete
  3. Run npm start.
  4. Open localhost:3000 to see the project demo.

Table of Contents

Technology Stack 🛠️

Dependencies defined in package.json:

Reactjs | Bootstrap | Typist | GitHub API | Particles | Instagram API

Structure ⚓

  • Navigation bar (optional)
  • Blog (optional)
  • Body
    • Name | Profession
    • Contact / Follow / Find me / Facebook / LinkedIn / GitHub / Instagram / Email / CodePen
    • Resume | About me
  • About Me
    • About myself, my Interests, Goals and Hobbies
    • Things I'm good at (Skills)
    • Resume button
  • Recent Projects (using GitHub API) (optional)
  • Footer
    • Copyrights - open source

Sharing 💗

Project is open source. Feel free to make your own version. All you need to do is to fork this repository, edit src/editable-stuff/configurations.json and add resume. Hit on star ⭐ button if you like this project.

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>/Digital-Portfolio.git
  3. Open in any editor of your choice and edit src/editable-stuff/configurations.json file.

  4. Get a shareable link for your resume by uploading it to any cloud storage of your choice. (AWS S3bucket, GDrive, etc.)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/Digital-Portfolio"

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

  7. After editing run the following bash commands:

    npm install
    npm start