https://github.com/daviteixeira-dev/search-devs

In the proposed project, the goal is to build a React application that searches for developers' profiles in GitHub's public API and displays their data on a profile page.
https://github.com/daviteixeira-dev/search-devs

api-github date-fns primereact react react-router-dom typescript

Last synced: about 7 hours ago
JSON representation

In the proposed project, the goal is to build a React application that searches for developers' profiles in GitHub's public API and displays their data on a profile page.

• Host: GitHub
• URL: https://github.com/daviteixeira-dev/search-devs
• Owner: daviteixeira-dev
• Created: 2023-05-11T20:42:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-19T00:34:32.000Z (over 1 year ago)
• Last Synced: 2024-09-17T17:27:03.498Z (about 2 months ago)
• Topics: api-github, date-fns, primereact, react, react-router-dom, typescript
• Language: TypeScript
• Homepage: https://search-devs-steel.vercel.app
• Size: 121 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
  Search d_evs 




   🧩 Introdução    |   

   🧪 Dependências   |   

   🚀 Aplicação   |   

   📖 Scripts      





## 🧩 Introdução

### No projeto proposto, o objetivo é construir uma aplicação React que busque o perfil de desenvolvedores na API pública do GitHub e exiba seus dados em uma página de perfil.

### Histórias



  
Ao entrar na home page, é possível conseguir pesquisar o usuário pelo seu username do GitHub e ter os dados do usuário exibidos corretamente na página de perfil.

  
Na página de perfil, os repositórios são ordenados com o seguinte critério: dos que têm mais estrelas, para os que têm menos estrelas.

  
Os nomes dos repositórios são links que levam ao repositório original do GitHub.

  
Caso o usuário pesquisado possua um site nas informações de seu perfil, deve haver um link que ao clicar para que abra aquele site. O mesmo deve acontecer caso o usuário pesquisado tenha uma conta no twitter em seu perfil.

  
O botão de "Ver Perfil Completo" deve levar para a página do GitHub do usuário.





## 🧪 Dependencias

> Requisitos para rotar o código.



  


    Node

  

  


    npm

  

  


    PrimeReact

  

  


    TypeScript

  

  


    ViteJS

  

  


    date-fns

  

  


    React

  





## 🚀 Aplicação

### Instalação e inicialização do projeto

### ```COMANDOS```

#### Para instalar as dependências

```

 npm install

```

#### Para rodar o projeto

```

 npm run dev

```

#### Para rodar o build

```

 npm run build

```

> Porém, o site já esta com deploy feito na Vercel, basta acessar o link abaixo:

Site Link



## 📖 Scripts

```JSON

"scripts": {

  "dev": "npm run dev",

   "build": "npm run build",

   "lint": "eslint src --ext ts,tsx --report-unused-disable-directives --max-warnings 0",

   "preview": "vite preview"

}

```

### 📖 Dependencies 

```JSON

"dependencies": {

  "date-fns": "^2.30.0",

  "primeicons": "^6.0.1",

  "primereact": "^9.3.1",

  "react": "^18.2.0",

  "react-dom": "^18.2.0",

  "react-router-dom": "^6.11.1",

  "react-transition-group": "^4.4.5",

}

```

### 📖 devDependencies

```JSON

"devDependencies": {

  "@types/react": "^18.0.28",

  "@types/react-dom": "^18.0.11",

  "@typescript-eslint/eslint-plugin": "^5.57.1",

  "@typescript-eslint/parser": "^5.57.1",

  "@vitejs/plugin-react": "^4.0.0",

  "eslint": "^8.38.0",

  "eslint-plugin-react-hooks": "^4.6.0",

  "eslint-plugin-react-refresh": "^0.3.4",

  "typescript": "^5.0.2",

  "vite": "^4.3.2"

}

```

Feito com ❤️ por Davi Teixeira