Giter Site home page Giter Site logo

chi-0828 / profile-site Goto Github PK

View Code? Open in Web Editor NEW
29.0 2.0 4.0 13.44 MB

The profile-site is a personal website template, which is macos terminal style. The project is built by React, and provides user to easily customize the website.

Home Page: https://chi-0828.github.io/profile-site/

License: MIT License

CSS 84.73% HTML 1.29% JavaScript 13.97%
personal-homepage personal-website profile-website terminal-style-website website-template css html github-pages learn javascript

profile-site's Introduction

profile-site

image GitHub repository GitHub top language GitHub stars GitHub commit activity (branch) GitHub last commit (by committer) MIT License
npm version node version
profile-site is a template of MacOS terminal-style personal profile website

  • star โญ this project if you enjoy this template

Demo

Demo website link

see the demo website

Demo screenshot

Some demo images

ASCII art can be generated on an online tool, e.g., patorjk image image

Usage

download the source

git clone https://github.com/chi-0828/profile-site.git

run npm

cd profile-site
npm install
npm run start

customize your website
modify the title of public/index.html, change User to your name

<head>
    <meta charset="UTF-8">
    <!-- some codes -->
    <title>User</title>
    <!-- Put your name here -->
    <!-- some codes -->
</head>

src/img/me5.png is your personal image, src/customization/*.json is your personal information

cd src/customization
# change the introduction in *.json to your own information
# change the images in img/* to your own photo and your school/company logo

example-1: customize Experience.json

{
    "companies" : [
        {
            "logo" : "path related to src",
            "name" : "your company name",
            "position_time" : "your job title, when",
            "description" : "what you do"
        },
        {
            "logo" : "./img/patere-removebg-preview.png",
            "name" : "XXXX Co.",
            "position_time" : "Software Engineering Intern, Aug. 2021 - Jun. 2022",
            "description" : "Computer vision and deep learning project, e.g., implementing an object detection application for patient assistance"
        }
    ]
}

example-2: customize Introduction.json

{
    "intro" : "write your portfolio here",
    "github" : "your GitHub",
    "googlescholar" : "your google scholar (or your Gmail)",
    "linkedin" : "your LinkedIn",
    "orcid" : "your orcid (or any other social account, e.g., FB, IG)"
}

if you don't have npm on your PC, I recommend you download it or use the HTML version (the HTML version is no longer maintained)

git clone --branch html https://github.com/chi-0828/profile-site.git

if you want to deploy the site on your GitHub page

git clone https://github.com/chi-0828/profile-site.git
cd profile-site
vim package.json

configure package.json

{
    "//": "name is your project name",
    "name": "profile-site",
    "version": "0.1.0",
    "//": "change 'your-account' to your GitHub account and 'profile-site' to repository",
    "homepage": "https://your-account.github.io/profile-site",
    "..." : "..."
}
npm run deploy

There will be a new branch gh-pages on your repository; you can host the branch to be the GitHub page in setting
see the tutorial

Update

2323/06/28 | Add new tab "Project

customize Project.json to show your projects image

TODO

The project is under-going

  • add the animation of terminal-style text printing
  • add a new tab for "Project"
  • change the source code to React project (done)

profile-site's People

Contributors

chi-0828 avatar gary0828gary avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.