Skip to content

jsphkhan/react-gist-demo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Title

React Single Page Application demo that uses Github Gist API to show all public gists for an user.

Description

ReactJS Single Page App demo which has the following features:

  1. Search: When a user enters a username, it should be able to get a full list of public gists by that user.
  2. Filetype: Convert the filetypes of the files in the gist into a tag/badge, (e.g, if the returned gist has list of files containing python and javascript files, the gist should have the respective tags/badges).
  3. Fork: Username/Avatar of the last 3 users who forked it with avatar linking to the fork.

Libraries/Components used

  • create-react-app: Starter kit to create a reactjs app.
  • bootstrap css (4.1.3): For styling and basic layout.
  • react-router-dom (4.3.1): For routing between the search results screen and the detail screen.
  • redux, react-redux: For data state management.
  • redux-thunk: redux middleware library to dispatch asynchronous actions.
  • For api calls I am using the fetch() method, which returns a Promise.

Getting Started and Installing

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

  • First Git clone the repo into your computer
git clone https://github.com/jsphkhan/react-gist-demo.git
  • Open your terminal
$ cd react-gist-demo
$ npm install
  • This should install all the dependencies. Once done
  • Run
$ yarn start
or
$ npm start

Gif Demo

Demo

Generating a Production build

$ cd react-gist-demo
$ npm run build
or
$ yarn build

Live Demo (eg. Now)

I have deployed the demo application into Now(Zeit) server.

Possible Improvements

Authors

License

This project is licensed under the MIT License

About

React demo to fetch Github GIST data

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •