noham/gitprofile
1
0
Fork 0
mirror of https://github.com/NohamR/gitprofile.git synced 2026-05-25 04:17:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update repo name

Browse Source
This commit is contained in:
Ariful Alam
2022-03-20 02:23:44 +06:00
parent b864c2cdd7
commit 20ac254201
17 changed files with 64 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -4,12 +4,12 @@
If you have found an issue or would like to request a new feature, simply create a new issue detailing the request. We also welcome pull requests. See below for information on getting started with development and submitting pull requests. If you have found an issue or would like to request a new feature, simply create a new issue detailing the request. We also welcome pull requests. See below for information on getting started with development and submitting pull requests.
Please note we have a [code of conduct](https://github.com/arifszn/ezprofile/blob/main/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. Please note we have a [code of conduct](https://github.com/arifszn/gitprofile/blob/main/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
## Found an Issue? ## Found an Issue?
If you find a bug in the source code or a mistake in the documentation, you can help us by If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an issue to our [GitHub Repository](https://github.com/arifszn/ezprofile/issues/new). Even better you can submit a Pull Request submitting an issue to our [GitHub Repository](https://github.com/arifszn/gitprofile/issues/new). Even better you can submit a Pull Request
with a fix. with a fix.
## Submitting a Pull Request ## Submitting a Pull Request
@@ -27,8 +27,8 @@ with a fix.
Fork, then clone the repo: Fork, then clone the repo:
```sh ```sh
git clone https://github.com/your-username/ezprofile.git git clone https://github.com/your-username/gitprofile.git
cd ezprofile cd gitprofile
``` ```
Install dependencies: Install dependencies:

66
README.md
View File

@@ -1,24 +1,24 @@
<p align="center"> <p align="center">
<a href="http://arifszn.github.io/ezprofile" target="_blank"> <a href="http://arifszn.github.io/gitprofile" target="_blank">
<img src="https://arifszn.github.io/assets/img/hosted/ezprofile/logo.png" alt="ezProfile" title="ezProfile" width="80"> <img src="https://arifszn.github.io/assets/img/hosted/gitprofile/logo.png" alt="GitProfile" title="GitProfile" width="80">
</a> </a>
</p> </p>
<h1 align="center">ezProfile</h1> <h1 align="center">GitProfile</h1>
<p align="center">A modern, responsive and customizable portfolio builder for Developers!</p> <p align="center">A modern, responsive and customizable portfolio builder for Developers!</p>
<p align="center">https://arifszn.github.io/ezprofile</p> <p align="center">https://arifszn.github.io/gitprofile</p>
<br/> <br/>
<p align="center"> <p align="center">
<a href="https://arifszn.github.io/ezprofile"> <a href="https://arifszn.github.io/gitprofile">
<img src="https://arifszn.github.io/assets/img/hosted/ezprofile/preview.gif" width="60%" alt="Preview"/> <img src="https://arifszn.github.io/assets/img/hosted/gitprofile/preview.gif" width="60%" alt="Preview"/>
</a> </a>
<br/> <br/>
<a href="#arifszn"><img src="https://arifszn.github.io/assets/img/drop-shadow.png" width="60%" alt="Shadow"/></a> <a href="#arifszn"><img src="https://arifszn.github.io/assets/img/drop-shadow.png" width="60%" alt="Shadow"/></a>
</p> </p>
**ezProfile** is an easy-to-customize personal dev portfolio builder that is created with React.js. When you manage the code in a GitHub repository, it will automatically render a webpage with the owner's profile information, including a photo, bio, and public repositories. Also, it includes space to highlight your details, job history, education history, skills, and recent blog posts. **GitProfile** is an easy-to-customize personal dev portfolio builder that is created with React.js. When you manage the code in a GitHub repository, it will automatically render a webpage with the owner's profile information, including a photo, bio, and public repositories. Also, it includes space to highlight your details, job history, education history, skills, and recent blog posts.
It's all possible using [GitHub API](https://developer.github.com/v3/) (for automatically populating your website with content) and [Article-api](https://github.com/arifszn/article-api) (for fetching recent blog posts). It's all possible using [GitHub API](https://developer.github.com/v3/) (for automatically populating your website with content) and [Article-api](https://github.com/arifszn/article-api) (for fetching recent blog posts).
@@ -34,7 +34,7 @@ It's all possible using [GitHub API](https://developer.github.com/v3/) (for auto
✓ [Projects](#projects)\ ✓ [Projects](#projects)\
✓ [Blog Posts](#blog-posts) ✓ [Blog Posts](#blog-posts)
To view a live example, **[click here](https://arifszn.github.io/ezprofile)**. To view a live example, **[click here](https://arifszn.github.io/gitprofile)**.
## 🛠 Installation & Set Up ## 🛠 Installation & Set Up
@@ -44,7 +44,7 @@ These instructions will get you a copy of the project and deploy your website on
- Rename your forked repository to `username.github.io` in github, where `username` is your GitHub username (or organization name). - Rename your forked repository to `username.github.io` in github, where `username` is your GitHub username (or organization name).
- Go to your repo's **Actions** page and enable workflows. - Go to your repo's **Actions** page and enable workflows.
![Workflows](https://arifszn.github.io/assets/img/hosted/ezprofile/workflows.png) ![Workflows](https://arifszn.github.io/assets/img/hosted/gitprofile/workflows.png)
- Open `package.json`, and change `homepage`'s value to `https://username.github.io`. - Open `package.json`, and change `homepage`'s value to `https://username.github.io`.
@@ -70,15 +70,15 @@ As this is a create react app, you can also host your website to Netlify, Vercel
## 🎨 Customization ## 🎨 Customization
All the magic happens in the file `src/ezprofile.config.js`. Open it and modify it according to your preference. All the magic happens in the file `src/gitprofile.config.js`. Open it and modify it according to your preference.
These are the default values: These are the default values:
<details> <details>
<summary>ezprofile.config.js</summary> <summary>gitprofile.config.js</summary>
```js ```js
// ezprofile.config.js // gitprofile.config.js
const config = { const config = {
github: { github: {
username: 'arifszn', // Your GitHub org/user name. (Required) username: 'arifszn', // Your GitHub org/user name. (Required)
@@ -192,7 +192,7 @@ There are 21 themes available that can be selected from the dropdown.
The default theme can be specified. The default theme can be specified.
```js ```js
// ezprofile.config.js // gitprofile.config.js
module.exports = { module.exports = {
// ... // ...
themeConfig: { themeConfig: {
@@ -202,22 +202,22 @@ module.exports = {
}; };
``` ```
![Theme Dropdown](https://arifszn.github.io/assets/img/hosted/ezprofile/themes-1.png) ![Theme Dropdown](https://arifszn.github.io/assets/img/hosted/gitprofile/themes-1.png)
Here are some screenshots of different themes.\ Here are some screenshots of different themes.\
<br/> <br/>
![Themes](https://arifszn.github.io/assets/img/hosted/ezprofile/themes-2.png)\ ![Themes](https://arifszn.github.io/assets/img/hosted/gitprofile/themes-2.png)\
<br/> <br/>
![Themes](https://arifszn.github.io/assets/img/hosted/ezprofile/themes-6.png)\ ![Themes](https://arifszn.github.io/assets/img/hosted/gitprofile/themes-6.png)\
<br/> <br/>
![Themes](https://arifszn.github.io/assets/img/hosted/ezprofile/themes-7.png) ![Themes](https://arifszn.github.io/assets/img/hosted/gitprofile/themes-7.png)
### Google Analytics ### Google Analytics
ezFolio supports both GA3 and GA4. If you do not want to use Google Analytics, keep the `id` empty. ezFolio supports both GA3 and GA4. If you do not want to use Google Analytics, keep the `id` empty.
```js ```js
// ezprofile.config.js // gitprofile.config.js
module.exports = { module.exports = {
// ... // ...
googleAnalytics: { googleAnalytics: {
@@ -228,14 +228,14 @@ module.exports = {
Besides tracking visitors, ezFolio will track click events on projects and blog posts, and send them to Google Analytics.\ Besides tracking visitors, ezFolio will track click events on projects and blog posts, and send them to Google Analytics.\
<br/> <br/>
![Event](https://www.arifszn.com/assets/img/hosted/ezprofile/event.png) ![Event](https://www.arifszn.com/assets/img/hosted/gitprofile/event.png)
### Hotjar ### Hotjar
ezProfile supports hotjar. If you do not want to use Hotjar, keep the `id` empty. GitProfile supports hotjar. If you do not want to use Hotjar, keep the `id` empty.
```js ```js
// ezprofile.config.js // gitprofile.config.js
module.exports = { module.exports = {
// ... // ...
hotjar: { hotjar: {
@@ -253,14 +253,14 @@ Meta tags will be auto-generated from configs dynamically. However, you can also
Your github avatar and bio will be displayed here.\ Your github avatar and bio will be displayed here.\
<br/> <br/>
![Avatar Bio](https://arifszn.github.io/assets/img/hosted/ezprofile/avatar-card.png) ![Avatar Bio](https://arifszn.github.io/assets/img/hosted/gitprofile/avatar-card.png)
### Social Links ### Social Links
ezProfile supports linking your social media services you're using, including LinkedIn, Twitter, Facebook, Dribbble, Behance, Medium, dev.to, personal website, phone and email. GitProfile supports linking your social media services you're using, including LinkedIn, Twitter, Facebook, Dribbble, Behance, Medium, dev.to, personal website, phone and email.
```js ```js
// ezprofile.config.js // gitprofile.config.js
module.exports = { module.exports = {
// ... // ...
social: { social: {
@@ -283,7 +283,7 @@ module.exports = {
To showcase your skills provide them here. To showcase your skills provide them here.
```js ```js
// ezprofile.config.js // gitprofile.config.js
module.exports = { module.exports = {
// ... // ...
skills: ['JavaScript', 'React.js'], skills: ['JavaScript', 'React.js'],
@@ -297,7 +297,7 @@ Empty array will hide the skills section.
Provide your job history in `experiences`. Provide your job history in `experiences`.
```js ```js
// ezprofile.config.js // gitprofile.config.js
module.exports = { module.exports = {
// ... // ...
experiences: [ experiences: [
@@ -324,7 +324,7 @@ Empty array will hide the experience section.
Provide your education history in `education`. Provide your education history in `education`.
```js ```js
// ezprofile.config.js // gitprofile.config.js
module.exports = { module.exports = {
// ... // ...
education: [ education: [
@@ -351,7 +351,7 @@ Empty array will hide the education section.
Your public repo from github will be displayed here automatically. You can limit how many projects do you want to be displayed. Also, you can hide forked or specific repo. Your public repo from github will be displayed here automatically. You can limit how many projects do you want to be displayed. Also, you can hide forked or specific repo.
```js ```js
// ezprofile.config.js // gitprofile.config.js
module.exports = { module.exports = {
// ... // ...
github: { github: {
@@ -371,7 +371,7 @@ module.exports = {
If you have [medium](https://medium.com) or [dev.to](https://dev.to) account, you can show your recent blog posts in here just by providing your medium/dev.to username. You can limit how many posts to display (Max is `10`). If you have [medium](https://medium.com) or [dev.to](https://dev.to) account, you can show your recent blog posts in here just by providing your medium/dev.to username. You can limit how many posts to display (Max is `10`).
```js ```js
// ezprofile.config.js // gitprofile.config.js
module.exports = { module.exports = {
// ... // ...
blog: { blog: {
@@ -382,13 +382,13 @@ module.exports = {
}; };
``` ```
![Blog](https://arifszn.github.io/assets/img/hosted/ezprofile/blog.png) ![Blog](https://arifszn.github.io/assets/img/hosted/gitprofile/blog.png)
The posts are fetched by [Article-api](https://github.com/arifszn/article-api). The posts are fetched by [Article-api](https://github.com/arifszn/article-api).
## 📢 Please Read ## 📢 Please Read
I intend to keep my works open source. Please do not discourage me by claiming this work by copying it as your own. However, You are open to use this project by forking it and change any code necessary by giving attribute to the original author. Please see this [issue](https://github.com/arifszn/ezprofile/issues/11) for more info. I intend to keep my works open source. Please do not discourage me by claiming this work by copying it as your own. However, You are open to use this project by forking it and change any code necessary by giving attribute to the original author. Please see this [issue](https://github.com/arifszn/gitprofile/issues/11) for more info.
## 💖 Support ## 💖 Support
@@ -398,8 +398,8 @@ I intend to keep my works open source. Please do not discourage me by claiming t
## 💡 Contribute ## 💡 Contribute
To contribute, see the [Contributing guide](https://github.com/arifszn/ezprofile/blob/main/CONTRIBUTING.md). To contribute, see the [Contributing guide](https://github.com/arifszn/gitprofile/blob/main/CONTRIBUTING.md).
## 📄 License ## 📄 License
**ezProfile** is licensed under the [Apache-2.0 License](https://github.com/arifszn/ezprofile/blob/main/LICENSE). **GitProfile** is licensed under the [Apache-2.0 License](https://github.com/arifszn/gitprofile/blob/main/LICENSE).

4
package-lock.json generated
View File

@@ -1,11 +1,11 @@
{ {
"name": "ezprofile", "name": "gitprofile",
"version": "1.1.1", "version": "1.1.1",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "ezprofile", "name": "gitprofile",
"version": "1.1.1", "version": "1.1.1",
"license": "Apache-2.0", "license": "Apache-2.0",
"dependencies": { "dependencies": {

6
package.json
View File

@@ -1,14 +1,14 @@
{ {
"name": "ezprofile", "name": "gitprofile",
"description": "Kickstart your personal portfolio with Github Api and blog", "description": "Kickstart your personal portfolio with Github Api and blog",
"private": true, "private": true,
"version": "1.1.1", "version": "1.1.1",
"homepage": "https://arifszn.github.io/ezprofile", "homepage": "https://arifszn.github.io/gitprofile",
"license": "Apache-2.0", "license": "Apache-2.0",
"author": "arifszn", "author": "arifszn",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/arifszn/ezprofile.git" "url": "https://github.com/arifszn/gitprofile.git"
}, },
"scripts": { "scripts": {
"dev": "vite", "dev": "vite",

2
public/manifest.json
View File

@@ -1,5 +1,5 @@
{ {
"short_name": "ezProfile", "short_name": "GitProfile",
"name": "Personal Portfolio", "name": "Personal Portfolio",
"icons": [ "icons": [
{ {

10
src/App.jsx
View File

@@ -1,7 +1,7 @@
import axios from 'axios'; import axios from 'axios';
import { Fragment, useCallback, useEffect, useState } from 'react'; import { Fragment, useCallback, useEffect, useState } from 'react';
import moment from 'moment'; import moment from 'moment';
import config from './ezprofile.config'; import config from './gitprofile.config';
import HeadTagEditor from './components/head-tag-editor'; import HeadTagEditor from './components/head-tag-editor';
import ErrorPage from './components/error-page'; import ErrorPage from './components/error-page';
import ThemeChanger from './components/theme-changer'; import ThemeChanger from './components/theme-changer';
@@ -127,7 +127,7 @@ function App() {
error === 404 ? ( error === 404 ? (
<p> <p>
Please provide correct github username in{' '} Please provide correct github username in{' '}
<code>src/ezprofile.config.js</code> <code>src/gitprofile.config.js</code>
</p> </p>
) : error === 429 ? ( ) : error === 429 ? (
<p> <p>
@@ -174,7 +174,7 @@ function App() {
</div> </div>
</div> </div>
</div> </div>
{/* DO NOT REMOVE/MODIFY THE FOOTER. FOR MORE INFO https://github.com/arifszn/ezprofile#-please-read */} {/* DO NOT REMOVE/MODIFY THE FOOTER. FOR MORE INFO https://github.com/arifszn/gitprofile#-please-read */}
<footer className="p-4 footer bg-base-200 text-base-content footer-center"> <footer className="p-4 footer bg-base-200 text-base-content footer-center">
<div className="card compact bg-base-100 shadow"> <div className="card compact bg-base-100 shadow">
<div className="card-body"> <div className="card-body">
@@ -183,11 +183,11 @@ function App() {
Made with{' '} Made with{' '}
<a <a
className="text-primary" className="text-primary"
href="https://github.com/arifszn/ezprofile" href="https://github.com/arifszn/gitprofile"
target="_blank" target="_blank"
rel="noreferrer" rel="noreferrer"
> >
ezProfile GitProfile
</a>{' '} </a>{' '}
and ❤️ and ❤️
</p> </p>

2
src/components/blog/index.jsx
View File

@@ -1,7 +1,7 @@
import { getDevtoArticle, getMediumArticle } from 'article-api'; import { getDevtoArticle, getMediumArticle } from 'article-api';
import moment from 'moment'; import moment from 'moment';
import { Fragment, useEffect, useState } from 'react'; import { Fragment, useEffect, useState } from 'react';
import config from '../../ezprofile.config'; import config from '../../gitprofile.config';
import { ga, skeleton } from '../../helpers/utils'; import { ga, skeleton } from '../../helpers/utils';
import LazyImage from '../lazy-image'; import LazyImage from '../lazy-image';
import PropTypes from 'prop-types'; import PropTypes from 'prop-types';

2
src/components/details/index.jsx
View File

@@ -14,7 +14,7 @@ import {
} from 'react-icons/fa'; } from 'react-icons/fa';
import PropTypes from 'prop-types'; import PropTypes from 'prop-types';
import { skeleton } from '../../helpers/utils'; import { skeleton } from '../../helpers/utils';
import config from '../../ezprofile.config'; import config from '../../gitprofile.config';
const ListItem = ({ icon, title, value, link, skeleton = false }) => { const ListItem = ({ icon, title, value, link, skeleton = false }) => {
return ( return (

2
src/components/education/index.jsx
View File

@@ -1,5 +1,5 @@
import { skeleton } from '../../helpers/utils'; import { skeleton } from '../../helpers/utils';
import config from '../../ezprofile.config'; import config from '../../gitprofile.config';
import { Fragment } from 'react'; import { Fragment } from 'react';
import PropTypes from 'prop-types'; import PropTypes from 'prop-types';

2
src/components/experience/index.jsx
View File

@@ -1,5 +1,5 @@
import { skeleton } from '../../helpers/utils'; import { skeleton } from '../../helpers/utils';
import config from '../../ezprofile.config'; import config from '../../gitprofile.config';
import { Fragment } from 'react'; import { Fragment } from 'react';
import PropTypes from 'prop-types'; import PropTypes from 'prop-types';

2
src/components/head-tag-editor/index.jsx
View File

@@ -1,7 +1,7 @@
import { Fragment } from 'react'; import { Fragment } from 'react';
import { Helmet } from 'react-helmet-async'; import { Helmet } from 'react-helmet-async';
import PropTypes from 'prop-types'; import PropTypes from 'prop-types';
import config from '../../ezprofile.config'; import config from '../../gitprofile.config';
import { isThemeDarkish } from '../../helpers/utils'; import { isThemeDarkish } from '../../helpers/utils';
const HeadTagEditor = ({ profile, theme }) => { const HeadTagEditor = ({ profile, theme }) => {

2
src/components/project/index.jsx
View File

@@ -1,7 +1,7 @@
import { Fragment } from 'react'; import { Fragment } from 'react';
import { AiOutlineStar, AiOutlineFork } from 'react-icons/ai'; import { AiOutlineStar, AiOutlineFork } from 'react-icons/ai';
import PropTypes from 'prop-types'; import PropTypes from 'prop-types';
import config from '../../ezprofile.config'; import config from '../../gitprofile.config';
import { ga, languageColor, skeleton } from '../../helpers/utils'; import { ga, languageColor, skeleton } from '../../helpers/utils';
const Project = ({ repo, loading }) => { const Project = ({ repo, loading }) => {

2
src/components/skill/index.jsx
View File

@@ -1,4 +1,4 @@
import config from '../../ezprofile.config'; import config from '../../gitprofile.config';
import { skeleton } from '../../helpers/utils'; import { skeleton } from '../../helpers/utils';
import PropTypes from 'prop-types'; import PropTypes from 'prop-types';

4
src/components/theme-changer/index.jsx
View File

@@ -1,13 +1,13 @@
import { AiOutlineControl } from 'react-icons/ai'; import { AiOutlineControl } from 'react-icons/ai';
import { skeleton } from '../../helpers/utils'; import { skeleton } from '../../helpers/utils';
import config from '../../ezprofile.config'; import config from '../../gitprofile.config';
import PropTypes from 'prop-types'; import PropTypes from 'prop-types';
const ThemeChanger = ({ theme, setTheme, loading }) => { const ThemeChanger = ({ theme, setTheme, loading }) => {
const changeTheme = (e, selectedTheme) => { const changeTheme = (e, selectedTheme) => {
e.preventDefault(); e.preventDefault();
document.querySelector('html').setAttribute('data-theme', selectedTheme); document.querySelector('html').setAttribute('data-theme', selectedTheme);
localStorage.setItem('ezprofile-theme', selectedTheme); localStorage.setItem('gitprofile-theme', selectedTheme);
setTheme(selectedTheme); setTheme(selectedTheme);
}; };

0
src/ezprofile.config.js → src/gitprofile.config.js
View File

6
src/helpers/utils.jsx
View File

@@ -1,4 +1,4 @@
import config from '../ezprofile.config'; import config from '../gitprofile.config';
import colors from '../data/colors.json'; import colors from '../data/colors.json';
import { hotjar } from 'react-hotjar'; import { hotjar } from 'react-hotjar';
@@ -7,8 +7,8 @@ export const getInitialTheme = () => {
return config.themeConfig.default; return config.themeConfig.default;
} }
if (!(localStorage.getItem('ezprofile-theme') === null)) { if (!(localStorage.getItem('gitprofile-theme') === null)) {
let theme = localStorage.getItem('ezprofile-theme'); let theme = localStorage.getItem('gitprofile-theme');
return theme; return theme;
} }

2
vite.config.js
View File

@@ -3,6 +3,6 @@ import react from '@vitejs/plugin-react';
// https://vitejs.dev/config/ // https://vitejs.dev/config/
export default defineConfig({ export default defineConfig({
base: '/ezprofile/', base: '/gitprofile/',
plugins: [react()], plugins: [react()],
}); });