Skip to content

Commit

Permalink
First commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mshuber1981 committed Dec 4, 2020
0 parents commit a6db79d
Show file tree
Hide file tree
Showing 37 changed files with 19,303 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
.eslintcache

npm-debug.log*
yarn-debug.log*
yarn-error.log*
20 changes: 20 additions & 0 deletions License.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License (MIT)
Copyright (c) 2020 Michael Huber

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
172 changes: 172 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
[![GitHub Repo stars](https://img.shields.io/github/stars/mshuber1981/github-react-portfolio-template?color=%2361dbfb&style=for-the-badge&logo=github)](https://github.com/mshuber1981/github-react-portfolio-template/stargazers/)

# GitHub React Portfolio Template

A fast, responsive React portfolio template that uses the [GitHub REST API](https://docs.github.com/en/free-pro-team@latest/rest).

Add your GitHub username once and all of your info will automatically be updated. Deploy to GitHub pages in a few simple steps.

[Google PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights/)

![Page Speed](/images/speed.png)

### <a href="https://mshuber1981.github.io/github-react-portfolio-template/">LIVE DEMO</a>

![Project Preview](/images/preview.png)

## Getting Started

1. Clone/download
1. Install the dependencies

- ```bash
npm i
```

1. Navigate to the src directory and open data.js
1. Add your GitHub username (data.js line 19)

- ```javascript
/* START HERE - add your GitHub username below
************************************************************** */
export const githubUsername = "your GitHub username here";
```

1. Start the development server to view the results

- ```bash
npm start
```

## Updating the Skills section

![Skills Preview](/images/skills.png)

1. Import your desired skill icons (data.js line 1)

- ```javascript
// https://react-icons.github.io/
import {
FaHtml5,
FaCss3Alt,
FaSass,
FaBootstrap,
FaReact,
FaNpm,
FaGitAlt,
FaGithubSquare,
} from "react-icons/fa";
import { SiJavascript } from "react-icons/si";
```

1. Follow the instructions to update the skillData array (data.js line 23)

- ```javascript
/* Skills
************************************************************** */
// Add or remove skills in the SAME format below
// There must be one icon imported above per skill below and 3 skills per row
export const skillData = [
{
id: 1,
skill: <FaHtml5 className="display-4" />,
nameId: 1,
name: "HTML5",
},
```

## Updating the Projects section

![Projects Preview](/images/projects.png)

1. Follow the instructions to update the filteredProjects array (data.js line 83)

- ```javascript
/* Projects
************************************************************** */
// List the repo names you want to include (they will be sorted alphabetically)
// Leave the array empty if you want to include everything
export const filteredProjects = [
"Background-Generator",
"github-react-portfolio-template",
"notepad",
];
```

1. Import the project images you want to use (data.js line 14), skip steps 2-3 if you want to use the default image

- ```javascript
// Projects Images
// Add your images to the /assets/images directory and import below
import colors from "./assets/images/colors.svg";
import robot from "./assets/images/robot.svg";
import notepad from "./assets/images/notepad.svg";
```

1. Follow the instructions to update the projectData array (data.js line 92)

- ```javascript
// List the card images you want to include in the same order as the repos above
// There MUST be one image per repo above or the defualt image will be applied
export const projectData = [
{
imageId: 1,
image: colors,
},
{
imageId: 2,
image: notepad,
},
{
imageId: 3,
image: robot,
},
];
```

## Updating the Contact section

![Contact Preview](/images/contact.png)

1. Follow the instructions to update the contactInfo object (data.js line 109)

- ```javascript
/* Contact Info
************************************************************** */
// Share the contact info you are comfortable with (no dashes for phone numbers)
// If no info provided a button with a link to mailchimp will be rendered
// Update the link if you want to use this option
export const contactInfo = {
email: "",
phone: "",
mailChimp: "https://www.mailchimp.com/",
};
```

## Deploy

A helpful guide for Create React App deployments with GitHub Pages can be found <a href="https://create-react-app.dev/docs/deployment#github-pages">here</a>.

1. Update the homepage value in package.json (line 3)

- ```javascript
"homepage": "https://myusername.github.io/my-app",
```

1. Run the deployment command

- ```bash
npm run deploy
```

## Donate

Was this helpful? Feeling generous? Please consider donating below.

My [Coinbase](https://www.coinbase.com/) Bitcoin wallet address:

![Donate](/images/donate.png)

## License

[MIT](https://choosealicense.com/licenses/mit/)
Binary file added images/contact.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/donate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/projects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/skills.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/speed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a6db79d

Please sign in to comment.