Logo

Github Finder

Find github user easily


A tool to search a user from Github using the Github’s API.

It’s a mini-project created thanks to bradtraversy’s course on Udemy.

This project use Typescript instead of Javascript.

⏩ Getting Started

1) Install Docker and Docker-Compose

Follow this official guide to install Docker and Docker-Compose

2) Setup Github Finder

Firstly, you need to clone the project

git clone [email protected]:MrZalTy/GithubFinder.git

Then you need to edit .env.example, fill it with the appropriates values and finally renames it to .env

3) Run Github Finder πŸš€

# Run Github Finder docker image
docker-compose up

You are now ready to access to the webapp on 127.0.0.1:3000 πŸ’₯ !

πŸ’« Overview

Home

Home

About

About

User’s Profile

User's Profile

πŸ’» Technologies

react
typescript
docker

πŸ“ License

Github Finder is distributed under the MIT License

πŸ‘Œ Authors


avatar

MrZalTy


πŸš€ Don’t forgot to put a ⭐ on my repositories !

GitHub

View Github