Giter VIP home page Giter VIP logo

repo-finder's Introduction

Repo Finder

UI tool designed to search for GitHub repos using GitHub API. The app is written in React and TypeScript. The script is built using Webpack bundling tool.

Requirements

  • Node 12+
  • NPM 6.13.4+

Setup

  • Git clone, or download the repo
  • Run npm i to install the dependencies

Building the app

Development

This mode is useful for debugging. The Webpack will run with a -w flag in order to watch for changes. JS/CSS will not be minified in this mode.

To build the app in development mode use the following command:

npm run build:dev

Production

In this mode the bundled code wil be optimized for production. All bundled JS/CSS will be minified.

To build the app in production mode use the following command:

npm run build:prod

Running the app

Use the following command to launch the app on localhost's port 9000

npm start

Unit tests

The app is using Jest framework for unit testing.

To test all files once run

npm test

To test all files in TDD mode (watch for file changes) run

npm run test:tdd

You can also target specific files.

Ex.

npm test RepoSearchAdapter
npm run test:tdd RepoSearchAdapter

repo-finder's People

Contributors

zakirt 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.