Developer's Portfolio ✨

It is a personal static website/portfolio template hosted with GitHub Pages, built to showcase my recent projects. Site URL / Demo: oaoni.github.io

Table of Contents

• Technology Stack 🛠️
• Structure ⚓
• Sharing 💗
• Prerequisites 🍪
• Setup And Deployment 🔧
• Contributing 🙌
• Issues
• Upcoming Features / Improvements 🔗
• Showcase 🚀
• Versão em Português 🇧🇷

Technology Stack 🛠️

Dependencies defined in package.json:

Reactjs | Bootstrap | Typist | GitHub API | 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
  • Display picture (using Instagram API) (optional)
  • About myself, my Interests, Goals and Hobbies
  • Things I'm good at (Skills)
  • Resume button
• Recent Projects (using GitHub API) (optional)
• Footer
  • Acknowledgements (contributors)
  • Copyrights - open source
  • (quote: Dream big, Think big)

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. Mark star ⭐ 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>/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. 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
   

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

Facing issues? Feel free to contact at [email protected].

Contributing 🙌

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Issues

If anyone is looking to make some contribution, the following are issues that you can solve:

• UI improvements
• Code optimization
• Routing
• SEO

Upcoming Features / Improvements 🔗

• Button and place for resume/CV.
• Option: add or not to add Instagram's display picture.
• Number of projects to show in website.
• If the Number of Projects are zero, hide the heading (Recent Projects).
• Blogs page.
• Make resume optional.

Showcase 🚀

Have you changed something in the code to create your own version? Feel free to share with me, I will list them in this space.

Guhyun Chung	Hamza Sohail	Aymun Tariq
Ana Ashrafi	Jeffery John	Remi Mestdagh

Versão em Português 🇧🇷

Esse projeto foi traduzido para português! Se você gostou dele e quer criar a sua própria versão, confira o repositório do @tashima42 em https://github.com/Tashima42/home. Novas contribuições e revisões na tradução são muito bem vindas!

Stargazers over time