Ariful Alam
GitHub
commit
fe21ead1f2
@ -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.
|
||||
|
||||
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?
|
||||
|
||||
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.
|
||||
|
||||
## Submitting a Pull Request
|
||||
@ -27,8 +27,8 @@ with a fix.
|
||||
Fork, then clone the repo:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/your-username/ezprofile.git
|
||||
cd ezprofile
|
||||
git clone https://github.com/your-username/gitprofile.git
|
||||
cd gitprofile
|
||||
```
|
||||
|
||||
Install dependencies:
|
||||
|
||||
66
README.md
66
README.md
@ -1,24 +1,24 @@
|
||||
<p align="center">
|
||||
<a href="http://arifszn.github.io/ezprofile" target="_blank">
|
||||
<img src="https://arifszn.github.io/assets/img/hosted/ezprofile/logo.png" alt="ezProfile" title="ezProfile" width="80">
|
||||
<a href="http://arifszn.github.io/gitprofile" target="_blank">
|
||||
<img src="https://arifszn.github.io/assets/img/hosted/gitprofile/logo.png" alt="GitProfile" title="GitProfile" width="80">
|
||||
</a>
|
||||
</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">https://arifszn.github.io/ezprofile</p>
|
||||
<p align="center">https://arifszn.github.io/gitprofile</p>
|
||||
|
||||
<br/>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://arifszn.github.io/ezprofile">
|
||||
<img src="https://arifszn.github.io/assets/img/hosted/ezprofile/preview.gif" width="60%" alt="Preview"/>
|
||||
<a href="https://arifszn.github.io/gitprofile">
|
||||
<img src="https://arifszn.github.io/assets/img/hosted/gitprofile/preview.gif" width="60%" alt="Preview"/>
|
||||
</a>
|
||||
<br/>
|
||||
<a href="#arifszn"><img src="https://arifszn.github.io/assets/img/drop-shadow.png" width="60%" alt="Shadow"/></a>
|
||||
</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).
|
||||
|
||||
@ -34,7 +34,7 @@ It's all possible using [GitHub API](https://developer.github.com/v3/) (for auto
|
||||
✓ [Projects](#projects)\
|
||||
✓ [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
|
||||
|
||||
@ -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).
|
||||
- Go to your repo's **Actions** page and enable workflows.
|
||||
|
||||
|
||||
|
||||
|
||||
- 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
|
||||
|
||||
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:
|
||||
|
||||
<details>
|
||||
<summary>ezprofile.config.js</summary>
|
||||
<summary>gitprofile.config.js</summary>
|
||||
|
||||
```js
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
const config = {
|
||||
github: {
|
||||
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.
|
||||
|
||||
```js
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
themeConfig: {
|
||||
@ -202,22 +202,22 @@ module.exports = {
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
Here are some screenshots of different themes.\
|
||||
<br/>
|
||||
\
|
||||
\
|
||||
<br/>
|
||||
\
|
||||
\
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
### Google Analytics
|
||||
|
||||
ezFolio supports both GA3 and GA4. If you do not want to use Google Analytics, keep the `id` empty.
|
||||
|
||||
```js
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
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.\
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
### 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
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
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.\
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
### 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
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
social: {
|
||||
@ -283,7 +283,7 @@ module.exports = {
|
||||
To showcase your skills provide them here.
|
||||
|
||||
```js
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
skills: ['JavaScript', 'React.js'],
|
||||
@ -297,7 +297,7 @@ Empty array will hide the skills section.
|
||||
Provide your job history in `experiences`.
|
||||
|
||||
```js
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
experiences: [
|
||||
@ -324,7 +324,7 @@ Empty array will hide the experience section.
|
||||
Provide your education history in `education`.
|
||||
|
||||
```js
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
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.
|
||||
|
||||
```js
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
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`).
|
||||
|
||||
```js
|
||||
// ezprofile.config.js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
blog: {
|
||||
@ -382,13 +382,13 @@ module.exports = {
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
The posts are fetched by [Article-api](https://github.com/arifszn/article-api).
|
||||
|
||||
## 📢 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
|
||||
|
||||
@ -398,8 +398,8 @@ I intend to keep my works open source. Please do not discourage me by claiming t
|
||||
|
||||
## 💡 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
|
||||
|
||||
**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
4
package-lock.json
generated
@ -1,11 +1,11 @@
|
||||
{
|
||||
"name": "ezprofile",
|
||||
"name": "gitprofile",
|
||||
"version": "1.1.1",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "ezprofile",
|
||||
"name": "gitprofile",
|
||||
"version": "1.1.1",
|
||||
"license": "Apache-2.0",
|
||||
"dependencies": {
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
{
|
||||
"name": "ezprofile",
|
||||
"name": "gitprofile",
|
||||
"description": "Kickstart your personal portfolio with Github Api and blog",
|
||||
"private": true,
|
||||
"version": "1.1.1",
|
||||
"homepage": "https://arifszn.github.io/ezprofile",
|
||||
"homepage": "https://arifszn.github.io/gitprofile",
|
||||
"license": "Apache-2.0",
|
||||
"author": "arifszn",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/arifszn/ezprofile.git"
|
||||
"url": "https://github.com/arifszn/gitprofile.git"
|
||||
},
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"short_name": "ezProfile",
|
||||
"short_name": "GitProfile",
|
||||
"name": "Personal Portfolio",
|
||||
"icons": [
|
||||
{
|
||||
|
||||
10
src/App.jsx
10
src/App.jsx
@ -1,7 +1,7 @@
|
||||
import axios from 'axios';
|
||||
import { Fragment, useCallback, useEffect, useState } from 'react';
|
||||
import moment from 'moment';
|
||||
import config from './ezprofile.config';
|
||||
import config from './gitprofile.config';
|
||||
import HeadTagEditor from './components/head-tag-editor';
|
||||
import ErrorPage from './components/error-page';
|
||||
import ThemeChanger from './components/theme-changer';
|
||||
@ -127,7 +127,7 @@ function App() {
|
||||
error === 404 ? (
|
||||
<p>
|
||||
Please provide correct github username in{' '}
|
||||
<code>src/ezprofile.config.js</code>
|
||||
<code>src/gitprofile.config.js</code>
|
||||
</p>
|
||||
) : error === 429 ? (
|
||||
<p>
|
||||
@ -174,7 +174,7 @@ function App() {
|
||||
</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">
|
||||
<div className="card compact bg-base-100 shadow">
|
||||
<div className="card-body">
|
||||
@ -183,11 +183,11 @@ function App() {
|
||||
Made with{' '}
|
||||
<a
|
||||
className="text-primary"
|
||||
href="https://github.com/arifszn/ezprofile"
|
||||
href="https://github.com/arifszn/gitprofile"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
ezProfile
|
||||
GitProfile
|
||||
</a>{' '}
|
||||
and ❤️
|
||||
</p>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
import { getDevtoArticle, getMediumArticle } from 'article-api';
|
||||
import moment from 'moment';
|
||||
import { Fragment, useEffect, useState } from 'react';
|
||||
import config from '../../ezprofile.config';
|
||||
import config from '../../gitprofile.config';
|
||||
import { ga, skeleton } from '../../helpers/utils';
|
||||
import LazyImage from '../lazy-image';
|
||||
import PropTypes from 'prop-types';
|
||||
|
||||
@ -14,7 +14,7 @@ import {
|
||||
} from 'react-icons/fa';
|
||||
import PropTypes from 'prop-types';
|
||||
import { skeleton } from '../../helpers/utils';
|
||||
import config from '../../ezprofile.config';
|
||||
import config from '../../gitprofile.config';
|
||||
|
||||
const ListItem = ({ icon, title, value, link, skeleton = false }) => {
|
||||
return (
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
import { skeleton } from '../../helpers/utils';
|
||||
import config from '../../ezprofile.config';
|
||||
import config from '../../gitprofile.config';
|
||||
import { Fragment } from 'react';
|
||||
import PropTypes from 'prop-types';
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
import { skeleton } from '../../helpers/utils';
|
||||
import config from '../../ezprofile.config';
|
||||
import config from '../../gitprofile.config';
|
||||
import { Fragment } from 'react';
|
||||
import PropTypes from 'prop-types';
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
import { Fragment } from 'react';
|
||||
import { Helmet } from 'react-helmet-async';
|
||||
import PropTypes from 'prop-types';
|
||||
import config from '../../ezprofile.config';
|
||||
import config from '../../gitprofile.config';
|
||||
import { isThemeDarkish } from '../../helpers/utils';
|
||||
|
||||
const HeadTagEditor = ({ profile, theme }) => {
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
import { Fragment } from 'react';
|
||||
import { AiOutlineStar, AiOutlineFork } from 'react-icons/ai';
|
||||
import PropTypes from 'prop-types';
|
||||
import config from '../../ezprofile.config';
|
||||
import config from '../../gitprofile.config';
|
||||
import { ga, languageColor, skeleton } from '../../helpers/utils';
|
||||
|
||||
const Project = ({ repo, loading }) => {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import config from '../../ezprofile.config';
|
||||
import config from '../../gitprofile.config';
|
||||
import { skeleton } from '../../helpers/utils';
|
||||
import PropTypes from 'prop-types';
|
||||
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
import { AiOutlineControl } from 'react-icons/ai';
|
||||
import { skeleton } from '../../helpers/utils';
|
||||
import config from '../../ezprofile.config';
|
||||
import config from '../../gitprofile.config';
|
||||
import PropTypes from 'prop-types';
|
||||
|
||||
const ThemeChanger = ({ theme, setTheme, loading }) => {
|
||||
const changeTheme = (e, selectedTheme) => {
|
||||
e.preventDefault();
|
||||
document.querySelector('html').setAttribute('data-theme', selectedTheme);
|
||||
localStorage.setItem('ezprofile-theme', selectedTheme);
|
||||
localStorage.setItem('gitprofile-theme', selectedTheme);
|
||||
|
||||
setTheme(selectedTheme);
|
||||
};
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import config from '../ezprofile.config';
|
||||
import config from '../gitprofile.config';
|
||||
import colors from '../data/colors.json';
|
||||
import { hotjar } from 'react-hotjar';
|
||||
|
||||
@ -7,8 +7,8 @@ export const getInitialTheme = () => {
|
||||
return config.themeConfig.default;
|
||||
}
|
||||
|
||||
if (!(localStorage.getItem('ezprofile-theme') === null)) {
|
||||
let theme = localStorage.getItem('ezprofile-theme');
|
||||
if (!(localStorage.getItem('gitprofile-theme') === null)) {
|
||||
let theme = localStorage.getItem('gitprofile-theme');
|
||||
return theme;
|
||||
}
|
||||
|
||||
|
||||
@ -3,6 +3,6 @@ import react from '@vitejs/plugin-react';
|
||||
|
||||
// https://vitejs.dev/config/
|
||||
export default defineConfig({
|
||||
base: '/ezprofile/',
|
||||
base: '/gitprofile/',
|
||||
plugins: [react()],
|
||||
});
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user