Skip to content

npranto/quick-display

Repository files navigation

quick-display


Lists
Quick Display

A quick and simple single page to display and showcase your GitHub projects

Table of Contents

Key Features

  • No longer need to build a completely new website to display your projects anymore
  • Quickly get a few default sections (feature, how to use, technologies and contributors) to showcase your projects in detail
  • All sections are component based and highly customizable, which makes it much easier to create and integrate new sections as wished
  • Default sections are fully responsive, so no need to worry about the display on mobile devices
  • Easily deployable with surge (refer to surge)

Getting Started

How To Setup the Environment

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/npranto/quick-display.git showcase

# Go into the repository
$ cd lists

# Remove .git directory
$ rm -rf .git

# Install dependencies
$ npm install

# Run the app on development
$ npm start

Credits

Source code makes use of several open source packages, a few keys ones include...

  • Babel - To transpile ES6+ syntax to ES5, in order to run source code inside browser
  • Webpack - For module bundling and generating distributing assets
  • ESLint - To lint source code for better readability, syntax consistency and proper formatting
  • plyr - A simple, accessible and customisable media player

Support

Buy Me A Coffee

License

MIT

Authors

About

A quick and simple single page to display and showcase your GitHub projects

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published