Code Monkey home page Code Monkey logo

gist-viewer-sample's Introduction

Gist Viewer

The Mission

To create a public gist viewer.

The TLDR

  1. Clone this repository
  2. Install dependencies with npm install
  3. Run the app with npm start
  4. Open http://localhost:3000 to view it in the browser.

The Details

Once finished, we should be able to search for a GitHub username and see all the public gists for that user. From each gist, we should be able to view all the files in that gist. To make things a little more interesting, we also want to be able to mark our favorite files inside a gist.

Time Taken

The goal was to build this in 2 hours. This would have given us a skeleton of an app, and I really wanted to show what I could do, so I spent about 6 on it all together. With more time, I could have built it out a lot more, including tests, a working api, using real gists, etc. I intend to do this on a rainy day, because this project was fun.

The API and Data

All static and hard-coded. The idea, though, is that with a very small amount of fine tuning, the app could very easily use a real api and real data.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

yarn test

In the interest of time, there are no tests. If we build it out more, we will include tests, but the requirements clearly said tests are not necessary in this specific task.

yarn build

Builds the app for production to the build folder.
It works, but there is absolutely no need to ever do this.

Acknowledgements

The boilerplate for the app is Create React App

gist-viewer-sample's People

Contributors

ingusmat avatar

Watchers

 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.