Skip to content

AM-77/github-user-finder

Repository files navigation

GitHub User Finder Logo

MIT License

GitHub User Finder

A GitHub user's profile finder.

This project was bootstrapped with Create React App.

Stack:

  • ReactJS
  • TypeScript
  • SASS
  • Apollo/client
  • GitHub GraphQL API

Deployed to:

  • vercel

Developement:

  • clone the repo:
  git clone https://github.com/AM-77/github-user-finder.git
  • setup the environment variables:

    create .env.local file and add:

      REACT_APP_GRAPHQL_ENDPOINT=https://api.github.com/graphql
      REACT_APP_GITHUB_API_TOKEN=<token>
    
  • run the app:

    • install dependencies :

      npm install
    • run tests:

      npm test
    • run the app:

      npm start

      The react app should be running in http://localhost:3000

Contribtion:

Feel free to open a pull requset 💁, report a bug 🐛 or request a feature 🌟 anytime you want.

License & copyright:

© AM-77 Licensed under the MIT License.