Skip to content

oh-my-github/viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Viewer

Default Viewer for oh-my-github, See Demo

Supported Browsers

  • Chrome (Recommended)
  • Safari
  • Firefox
  • IE 11+

Usage

See oh-my-github

Customization

  1. Edit app/src
$ cd app
$ npm install
$ npm start -s
  1. Build src and Run it on localhost
$ npm run build
$ npm run open:dist

Register your customized viewer to NPM

Modify theses fields in app/package.json.

{
  ...
  
  "name": "oh-my-github-viewer-default",
  "version": "0.0.1",
  "author": "1ambda",
  "description": "",
  "homepage": "https://github.com/oh-my-github/viewer#readme",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/oh-my-github/viewer.git"
  },
  "bugs": {
    "url": "https://github.com/oh-my-github/viewer/issues"
  },
  
  ...
}

Then publish it to NPM (See Also, Publishing NPM packages)

$ cd app
$ npm publish

Contributors

Library

Description Library Github
Boilerplate react-slingshot Github
UI Layout Library Materialize CSS Github
UI Component Library Material UI Github

License

Apache 2.0