suvadm

0.1.0 • Public • Published

ReactFolio License: GPL v3

Nice and Clean Responsive Dark Theme Portfolio Website with React!

캡처s

Demo Page

https://ikalli.github.io/ReactFolio

Contents

  • Greeting and Summary
  • Skills
  • Work Experiences
  • Open Source Projects(Github pinned repository)
  • Other Projects
  • Achievement and Certification
  • Blog Posts
  • Contact

Getting Started

You have to install Node.js and Git for use.

How To Use

  1. Fork or clone this repository.
git clone https://github.com/ikalli/ReactFolio.git  
cd ReactFolio
  1. Fill portfolio.tsx with your story!
  2. If you want to test your website, open terminal and follow below.
# project root directory
npm i
npm start

Yarn also possible! Then, new brower window maybe pop up with localhost:3000

  1. You NEED token, github personal access token, public use
  • goto https://github.com/settings/tokens
  • Click 'Personal access token'
  • Click 'Generate new token' and confirm password
  • Write token name in note
  • IMPORTANT! DO NOT CHECK IN SELECT SCOPE!! token
  • Click Generate token
  • Copy token - If you lose token, click regenerate token
  1. Create .env.local file in project root directory and write following 1-line code
--public
--src
--.env.local  // Create!
--.gitignore
--tsconfig.json
--package.json
...

# .env.local

REACT_APP_GITHUB_TOKEN = /your token/
  1. Open .gitignore and check .env.local is contained

If you get into trouble with Github Token, go to Reference part and click Github Docs
And you can see 6 or less repositories that you pinned.

  1. Change favicon, apple-touch-icon and other images.

  2. Change public/index.html meta tags!

  3. Modify Codes if you want!

Deploy

  • Install gh-pages module
  • npm i -D gh-pages or yarn add gh-pages
  • Modify package.json hompage to your github page

Example: homepage: https://[username].github.io/ReactFolio

  • open terminal and following instruction

npm run deploy

  • Then gh-pages branch will be automatically generated and you can see pages!!

Used Technologies

  • CSS3
  • TypeScript
  • React
  • Github GraphQL API
  • Apollo-Boost
  • react-easy-emoji
  • react-reveal

⚠ If you want to use react-reveal effect, you have to variable declaration with require().
⚠ Example

...import 

export default function Ex() {
  const Fade: any = require('react-reveal/Fade');
  return (
    <Fade>
      ...
    </Fade>
  );
}

Contributes

You can just change src/portfolio.tsx to get your portfolio website. Also you can modify component codes if you want!

But if you want to contribute to ReactFolio and make much better, look at Issues.

If you created something cool and want to contribute, open an Pull request.

Reference

Github Token

Github GraphQL API

DeveloperFolio

React Reveal

React Easy Emoji

gh-pages

Contributors

Readme

Keywords

none

Package Sidebar

Install

npm i suvadm

Weekly Downloads

1

Version

0.1.0

License

none

Unpacked Size

259 kB

Total Files

59

Last publish

Collaborators

  • suvadm