URL: https://gungho0619.github.io/git-user-search/
- Prettier for the code style check and cleanup
- Tailwind CSS for the CSS library
- Angular Material & CDK for the general UI component library
- GitHub Pages for the deployment
- Codecov for the code coverage integration and pipelines
- Every push will be tested via GitHub actions passing 3 steps - build, testing, code-coverage check.
main
branch is connected with the server(GitHub Page), whenever you push your code tomain
branch, that will be deployed to the hosting.- Code coverage is listed on the README.md by default, you can click this badge to check the report more details.
- Following the Conventional Commits for commits.
After clone the repository, following steps will allow you to set up the project on the local environment.
$ # Install packages
$ npm install
$
$ # Run project and check http://localhost:4200 from your browser
$ npm start
$
$ # Run unit test (single run - capable for CI)
$ npm run test
$
$ # Run unit test to generate code coverage
$ npm run test:cov
$
$ # Build the project in production mode
$ npm run build
$
$ # Other additional scripts can be found from the package.json - script section
This component should contain two elements:
- 'Login' Text input for entering a String value
- 'Submit' Button for initiating a request to
https://api.github.com/search/users?q={login} in:login
, where {login} is the input value
# Example curl GET request to search for for login `foo`
curl --request GET '[https://api.github.com/search/users?q=foo in:login](https://api.github.com/search/users?q=foo%20in:login)'