Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/saadpasta/developerfolio

🚀 Software Developer Portfolio Template that helps you showcase your work and skills as a software developer.
https://github.com/saadpasta/developerfolio
developer-folio developer-portfolio hacktoberfest portfolio portfolio-site portfolio-template portfolio-website portfolios react reactjs reactjs-template template
Last synced: about 1 month ago
JSON representation
🚀 Software Developer Portfolio Template that helps you showcase your work and skills as a software developer.
Host: GitHub
URL: https://github.com/saadpasta/developerfolio
Owner: saadpasta
License: gpl-3.0
Created: 2019-10-29T12:32:05.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-04-29T12:12:34.000Z (7 months ago)
Last Synced: 2024-05-02T02:09:08.413Z (7 months ago)
Topics: developer-folio, developer-portfolio, hacktoberfest, portfolio, portfolio-site, portfolio-template, portfolio-website, portfolios, react, reactjs, reactjs-template, template
Language: JavaScript
Homepage: https://developerfolio.js.org/
Size: 25.1 MB
Stars: 5,021
Watchers: 43
Forks: 2,552
Open Issues: 82
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # Software Developer Folio ⚡️ [![GitHub](https://img.shields.io/github/license/saadpasta/developer-portfolio?color=blue)](https://github.com/saadpasta/developerFolio/blob/master/LICENSE) [![GitHub stars](https://img.shields.io/github/stars/saadpasta/developerFolio)](https://github.com/saadpasta/developerFolio/stargazers)  [![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)

## A clean, beautiful and responsive portfolio template for Developers!



  



  



Just change `src/portfolio.js` to get your personal portfolio. Customize portfolio theme by using your own color scheme globally in the  `src/_globalColor.scss` file. Feel free to use it as-is or personalize it as much as you want.

If you'd like to **contribute** and make this much better for other users, have a look at [Issues](https://github.com/saadpasta/developerFolio/issues).

Created something awesome for your fork of the portfolio and want to share it? Feel free to open a [pull request](https://github.com/saadpasta/developerFolio/pulls).

## Table of Contents

- [Sections](#sections)

- [Getting Started](#getting-started)

- [How to Use](#how-to-use)

- [Linking portfolio to GitHub](#linking-portfolio-to-github)

- [Linking blogs section to Medium](#linking-blogs-section-to-medium)

- [Change and Customize](#change-and-customize-every-section-according-to-your-need)

- [Deployment](#deployment)

- [Technologies Used](#technologies-used)

- [Illustrations](#illustrations)

- [For the Future](#for-the-future)

- [Contributors](#project-maintainers)

## Portfolio Sections

✔️ Summary and About me\

✔️ Skills\

✔️ Education\

✔️ Work Experience\

✔️ Open Source Projects Connected with GitHub\

✔️ Big Projects\

✔️ Achievements And Certifications 🏆\

✔️ Blogs\

✔️ Talks\

✔️ Podcast\

✔️ Contact me\

✔️ Twitter Timeline\

✔️ GitHub Profile

To view a live example, **[click here](https://developerfolio.js.org/)**.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

You'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer or use [Docker](https://www.docker.com/products/docker-desktop).

```

[email protected] or higher

[email protected] or higher

[email protected] or higher

```

### Docker Commands

```

1) BUILD IMAGE : docker build -t developerfolio:latest .

2) RUN IMAGE: docker run -t -p 3000:3000 developerfolio:latest

```

## How To Use 

From your command line, clone and run developerFolio:

```bash

# Clone this repository

git clone https://github.com/saadpasta/developerFolio.git

# Go into the repository

cd developerFolio

# Setup default environment variables

# For Linux

cp env.example .env

# For Windows

copy env.example .env

# Install dependencies

npm install

# Start a local dev server

npm start

```

## Linking Portfolio to GitHub

Generate a classic GitHub personal access token following these [instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-personal-access-token-classic) (make sure you don't select any scope just generate a simple token). If you are using [GitHub Actions](#configuring-github-actions-recommended) to deploy your portfolio you can skip this section.

1. Create a file called .env in the root directory of your project (if not done already in section: [How To Use](#how-to-use))

Note: Configuring environment variables before deploying your portfolio is highly recommended as some components depend on API data. 

```bash

- DeveloperFolio

  - node_modules

  - public

  - src

  - .env         <-- create it here

  - env.example  <-- this is the base file

  - .gitignore

  - package-lock.json

  - package.json

```

2. Inside the .env file, add key `REACT_APP_GITHUB_TOKEN` and assign your GitHub token like this, also add your username as `GITHUB_USERNAME`

```env

// .env

REACT_APP_GITHUB_TOKEN = "YOUR GITHUB TOKEN HERE"

GITHUB_USERNAME = "YOUR GITHUB USERNAME"

USE_GITHUB_DATA = "true"

```

Set `showGithubProfile` to true or false to show Contact Profile using GitHub, defaults to false.

**Warning:** Treat your tokens like passwords and keep them secret. When working with the API, use tokens as environment variables instead of hardcoding them into your programs.

Note: Open Source Projects section only show pinned items of your GitHub.

If you are seeing something as shown below, follow these [instructions](https://docs.github.com/en/enterprise/2.13/user/articles/pinning-items-to-your-profile).

![ERROR](https://i.imgur.com/Hj6mu1K.png)

If the above solution still doesn't work, visit the [wiki page](https://github.com/saadpasta/developerFolio/wiki/Github-Setup-For-Open-Source-Projects).

## Linking blogs section to Medium

Optionally, you can link the blogs section to your medium user account:

* Inside the .env file, add key `MEDIUM_USERNAME` and assign your Medium username

```env

// .env

MEDIUM_USERNAME = "YOUR MEDIUM USERNAME"

```

* For Github Action, change the environment variable `MEDIUM_USERNAME` in `.github/workflows/deploy.yml`

Set `displayMediumBlogs` to true or false in portofolio.js to display fetched Medium blogs, defaults to true.

## Change and customize every section according to your need.

#### Personalize page content in `/src/portfolio.js` & modify it as per your need. You will also need to modify `index.html` to change the title and metadata to provide accurate SEO for your personal portfolio.

```javascript

/* Change this file to get your Personal Porfolio */

const greeting = {

  /* Your Summary And Greeting Section */

  title: "Hi all I'm Saad",

  subTitle: emoji("A passionate Full Stack Software Developer 🚀"),

  resumeLink: "https://drive.google.com/file/d/1ofFdKF_mqscH8WvXkSObnVvC9kK7Ldlu/view?usp=sharing"

};

const socialMediaLinks = {

  /* Your Social Media Link */

  github: "https://github.com/saadpasta",

  linkedin: "https://www.linkedin.com/in/saadpasta/",

  gmail: "[email protected]",

  gitlab: "https://gitlab.com/saadpasta",

  facebook: "https://www.facebook.com/saad.pasta7"

};

const skillsSection = { .... }

const techStack = { .... }

const workExperience = { .... }

const openSource = { .... }

const bigProjects = { .... }

const achievementSection = { .... }

const blogSection = { .... }

const contactInfo = { .... }

const twitterDetails = { ... }

```

#### Resume upload

To upload your own resume, simply upload a pdf to `src/containers/resume` and rename the pdf to `resume.pdf`. 

#### Using Emojis

For adding emoji 😃 into the texts in `Portfolio.js`, use the `emoji()` function and pass the text you need as an argument. This would help in keeping emojis compatible across different browsers and platforms.

#### Customize Lottie Animations

You can choose a Lottie and download it in json format from sites like [this](https://lottiefiles.com/). In `src/assets/lottie`, replace the Lottie json file you want to alter with the same file name. If you want to change the Lottie options, go to `src/components/displayLottie/DisplayLottie.js` and change the `defaultOptions` object, you can refer [lottie-react docs](https://www.npmjs.com/package/lottie-react) for more info on the `defaultOptions` object.

#### Adding Twitter Time line to your Page

Insert your Twitter username in `portfolio.js` to show your recent activity on your page.

```javascript

const twitterDetails = {

  userName : "Your Twitter Username"

};

```

Note: Don't use `@` symbol when adding username.

## Deployment

When you are done with the setup, you should host your website online.

We highly recommend to read through the [Deploying on GitHub Pages](https://create-react-app.dev/docs/deployment/#github-pages) docs for React.

#### Configuring GitHub Actions (Recommended)

First you should enable, GitHub Actions for the repository you use.

The Profile and the Repository information from GitHub is only created at the time of deploy and the site needs to be redeployed if those information needs to be updated. So, a configurable [CRON Job](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events) is setup which deploys your site every week, so that once you update your profile on GitHub it is shown on your portfolio. You can also trigger it manually using `workflow_dispatch` event, see [this guide](https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch) on how to do that.

- When you are done with the configuration, we highly recommend to read through the [GitHub Actions Configuring a workflow](https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow) docs.

#### Deploying to GitHub Pages

This section guides you to deploy your portfolio on GitHub pages.

- Navigate to `package.json` and enter your domain name instead of `https://developerfolio.js.org/` in `homepage` variable. For example, if you want your site to be `https://.github.io/developerFolio`, add the same to the homepage section of `package.json`.

- In short you can also add `/devloperFolio` to `package.json` as both are exactly same. Upon doing so, you tell `create-react-app` to add the path assets accordingly.

- Optionally, configure the domain. You can configure a custom domain with GitHub Pages by adding a `CNAME` file to the `public/` folder.

- Follow through the guide to setup GitHub pages from the official CRA docs [here](https://create-react-app.dev/docs/deployment/#github-pages).

#### Deploying to Netlify

You could also host directly with Netlify by linking your own repository.

[![Deploy To Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/saadpasta/developerFolio)

For more information, read [hosting on Netlify](https://create-react-app.dev/docs/deployment/#netlify).

## Technologies Used 

- [React](https://reactjs.org/)

- [graphql](https://graphql.org/)

- [apollo-boost](https://www.apollographql.com/docs/react/get-started/)

- [react-twitter-embed](https://github.com/saurabhnemade/react-twitter-embed)

- [react-easy-emoji](https://github.com/appfigures/react-easy-emoji)

- [react-headroom](https://github.com/KyleAMathews/react-headroom)

- [color-thief](https://github.com/lokesh/color-thief)

## Illustrations

- [UnDraw](https://undraw.co/illustrations)

- [Lottie by Oblikweare](https://lottiefiles.com/oblikweare)

## For the Future

If you can help us with these. Please don't hesitate to open a [pull request](https://github.com/saadpasta/developerFolio/pulls).

- Connect with LinkedIn to get Summary, Skills, Education and Experience

- Move to Gatsby

- Add More Sections

## Project Maintainers 

  

    
_{Saad Pasta}

    
_{Kartik Choudhary}

    
_{Naveen M K}

    
_{Muhammad Hasham}

  

## Contributors 

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_{Fawad Ali}
🤔 💻

      
_{Dasun Navoda}
📖

      
_{Brian Teeman}
📖

      
_{Rajkumar S}
💻

      
_{Slim Coder}
💻 📖

      
_{Mohamed Sayyaf}
📖

      
_{Ashutosh Hathidara}
💻

    

    

      
_{Rizwan Jamal ⚡️}
📖

      
_{Muhammad Hasham}
💻

      
_{UJJAWAL JOSHI}
💻

      
_{Palak Sethi}
💻

      
_{Vinicius Barbosa}
💻

      
_{Bharat Kammakatla}
🎨

      
_{Garima Singh}
💻

    

    

      
_{Henry Heng}
💻 🎨

      
_{Pulkit Banta}
💻 🐛

      
_{Akshay Kumar}
💻 🐛

      
_{Amna Ejaz}
💻 🤔

      
_{Paras Nagpal}
💻

      
_{Sparsh Garg}
💻

      
_{Aashutosh Rathi}
💻

    

    

      
_{Abhishek Kashyap}
🐛

      
_{Lucas V C Nicolau}
📖

      
_{Bradley C. Herrin}
📖 🤔

      
_{Zekinah Lecaros}
💻

      
_unbeat
📖

      
_{Arshad Ahmed}
📖

      
_{Xiaohui Liu}
📖 💻 🎨

    

    

      
_{Seungyeon-Lee}
💻

      
_{Najam Shehzad}
💻

      
_{Randy Jesus Real Srsen}
💻

      
_{Tamojit Das}
📖

      
_{Waren Gonzaga}
💻

      
_{Benjamin Bourgeois}
💻

      
_{Keshav Jain}
💻

    

    

      
_Hanzla
💻

      
_{Yogesh Rathod}
📖

      
_{Kunal Mundada}
📖

      
_{Anubhav Gupta}
💻

      
_{Vatsal Dave}
💻

      
_{Elvis Ciuffetelli}
💻

      
_{Scott Jellen}
💻 🎨

    

    

      
_{Karthik Mohan}
🐛

      
_mhowell11
📖

      
_gajanandh
🐛

      
_JooHyukKim
💻

      
_{Red Headphone}
💻 🐛

      
_{Sunit Roy}
🐛

      
_{Atir Nayab}
🐛

    

    

      
_{Shehriyar Qureshi}
💻

      
_respectech
💻

      
_Brayden
🐛

      
_{Canciu Costin}
💻

      
_{Atharv Singh}
💻

      
_{Ishan Khandelwal}
📖

      
_{Sergey Lyapustin}
💻

    

    

      
_{Camila Pozas}
💻

      
_{Sai Teja}
🐛

      
_{Vinit Hemadri}
💻

      
_{Njong Emy}
📖

      
_{Tamal Das}
📖

      
_Dunsin
💻

      
_{Muneeb Ahmed}
💻

    

    

      
_{Qais Attarwala}
💻

    

  

---