/github-users-search

Search github users (React,Redux,TypeScript,RX JS,Jest,Enzyme)

Primary LanguageTypeScript

github-users-search

Search github users (React,Redux,TypeScript,Jest,Enzyme). This project was bootstrapped with Create React App.I developed this repo for reference to me and other developers.

Tested with Jest jest

Build Status Coverage Status

Demo Link

https://devayarhlaine.github.io/github-users-search/

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.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Dependancies

State Management :

  • react-redux
  • redux
  • redux-thunk
  • @types/react-redux
  • typesafe-actions

Testing :

  • enzyme
  • enzyme-adapter-react-16
  • @types/enzyme
  • @types/enzyme-adapter-react-16

Getting API Data :

  • axios

CI/CD

Travis CI

I use Travis CI (Continuous Integration/Continuous Deployment) to deploy our site automatically to github pages.

CI/CD Report

Checking travis ci config file (.yml)?

Debounce Time Reference Questions

Current To Do List

  • Complete unit test coverage up to 90 %
  • Call github search api only when user complete typing ( Prefer to use rxjs debouncetime )
  • Enhancement on UI/UX

Contribution

I will make safe master brand.

Pull Request

  • Fork the repo and create your branch from master. A guide on how to fork a repository: https://help.github.com/articles/fork-a-repo/

  • Open terminal (e.g. Terminal, iTerm, Git Bash or Git Shell) and type:

  • $ git clone https://github.com/<your_username>/github-users-search
    $ cd github-users-search
    $ git checkout -b my_branch

  • Then create PR

Note : I generally don't accept pull requests that are untested, or break the build.

Issues

https://github.com/devayarhlaine/github-users-search/issues

Happy Coding!