Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mhdfaisal/digital-dev-resume
An online digital resume for developers - that make use of the github GraphQL API to keep itself updated based on your profile on github. An easy way to automate your online dev portfolio. It's very easy to customize also, checkout the README.md for more details.
https://github.com/mhdfaisal/digital-dev-resume
developer-portfolio digital-dev-resume easy-to-use github-api-v4 github-workflow graphql javascript material-ui reactjs shell typescript
Last synced: about 1 month ago
JSON representation
An online digital resume for developers - that make use of the github GraphQL API to keep itself updated based on your profile on github. An easy way to automate your online dev portfolio. It's very easy to customize also, checkout the README.md for more details.
- Host: GitHub
- URL: https://github.com/mhdfaisal/digital-dev-resume
- Owner: mhdfaisal
- Created: 2021-04-20T17:56:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-14T23:08:27.000Z (almost 2 years ago)
- Last Synced: 2023-03-02T18:41:31.150Z (almost 2 years ago)
- Topics: developer-portfolio, digital-dev-resume, easy-to-use, github-api-v4, github-workflow, graphql, javascript, material-ui, reactjs, shell, typescript
- Language: TypeScript
- Homepage: https://mohdfaisal.com
- Size: 4.32 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🖥️ Digital Dev Resume
## A fully functional responsive Digital Resume for Developers.
Just change the data for fields in `src/assets/portfolio-info.ts` to get your own personal digital resume.
## Table of Contents
- [Sections](#sections)
- [How to Use](#how-to-use)
- [Linking digital resume with Github](#linking-digital-dev-resume-to-github)
- [Changing static information](#change-static-information)
- [Deployment](#deployment)
## Sections
✔️ About\
✔️ Education & Work Experience\
✔️ Pinned Repositories (Repos pinned by you in your Github account)\
✔️ Recently Active Repositories (Repos recently being committed upon)\
✔️ Footer
## Getting Started
Setting up locally for development and testing purposes.
Make sure you have [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) installed on your system.
## How To Use
From your command line, clone and run digital-dev-resume:
```bash
# Clone this repository
$ git clone https://github.com/mhdfaisal/digital-dev-resume.git
# change into the repository
$ cd digital-dev-resume
# Install dependencies
$ yarn install
#Start development server
$ yarn start
```
Note: Change the homepage URL in the package.json file to yourusername.github.io
## Linking Digital Dev Resume to Github
Generate a Github personal access token by following these [instructions](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) (no need to select any scopes for this token).
1. Create a copy of the .env.example file in the root directory and rename the copied file to .env .
2. Enter the required values in the .env file as below -
```env
// .env
REACT_APP_GITHUB_TOKEN = "YOUR GITHUB TOKEN HERE"
GITHUB_USERNAME = "YOUR GITHUB USERNAME HERE"
```
## Change Static information
#### Just change the data for fields in `src/assets/portfolio-info.ts` to get your own personal digital resume.
## Deployment
Deploy on Github Pages by following the docs - [Deploying on Github Pages](https://create-react-app.dev/docs/deployment/#github-pages) docs for React.
#### Deploying using GitHub Actions (Recommended)
The data is fetched from github only once at the time of deployment. If we want our digital resume to stay updated with our new activities on github, we would need to redeploy it. So we can make use of a [CRON Job](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events) in our workflow to redeploy it twice or thrice in a week, so that it stay's updated with our github profile.
Docs for configuring and managing workflows - [Github Actions Configuring a workflow](https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)
## Contributions
If you want to add more sections or fix some open/hidden bug, please feel free to open an [pull request](https://github.com/mhdfaisal/digital-dev-resume/pulls).