This app allows users to search for Github users by their username. Once a user is found, the user can check details about the user such as their profile picture, name, number of followers and repositories. The user can also view the repositories owned by the user and their details like the repository name, description and navigate to the repository on github to check more details.
For this project, first you need to have node and yarn installed locally, then:
Clone the project
git clone https://github.com/samuelsilvadev/check-out-github-profiles
Go to the project directory
cd check-out-github-profiles
Install dependencies
yarn install
Start the server
yarn dev
To run this project, you will need to add the following environment variables to your .env
file
VITE_GITHUB_TOKEN
, VITE_GITHUB_BASE_API
.
You can also copy the .env.example
to speed up the process
cp .env.example .env
...the VITE_GITHUB_BASE_API
will come pre-filled and to insert the VITE_GITHUB_TOKEN
you need to create a github token. here you have a guide on how to do it.
To run tests, run the following command
yarn test
Client: React, React-router, Typescript.
Tests: Vitest, Msw, Testing-library.
Code quality: Prettier, Eslint, Typescript, Pre-commit.