smaEti/Github-user-search-app

an app that searches GitHub users using 3rd party API with React JS, Tailwind CSS , ViteJS, Axios , NodeJS , ExpressJs , React-icons

GitHub user search app

• Dark Mode
• Light Mode

Introduction 👋

GitHub usersearch app is built using ViteJS (for creating a react project and tailwind configs), ReactJS,Tailwind CSS and React-icons. Additionally, NodeJs and Express is used for backend services such as API services(using Axios in this project). The result is a dynamic and functional search app (Website) that searches users using github api.

Tech stack 🛠️

• ViteJS
• ReactJS
• Tailwind CSS
• NodeJS
• ExpressJS
• Axios
• React-icons

Development 💻

Here are the steps to run the project locally.

• Fork this repository.
• Clone your forked copy of the repo :

  $ git clone https://github.com/<YOUR-GITHUB-USERNAME>/Github-user-search-app.git
  

• install dependencies for react project

  $ cd .../Github-user-search-app/
  $ npm i
  

• install dependencies for express app

  $ cd .../Github-user-search-app/server/
  $ npm i
  

• for starting the app

  
  $ cd .../Github-user-search-app/
  $ npm run dev
  
  $ cd .../Github-user-search-app/server/
  $ node index.js
  

• for API-KEY
  • you should make a text file next to your project that contains the API_KEY that you got from Github.