Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/giovannak/github-list

Github list is a web application which shows the profile and repositories information of a specific github user.
https://github.com/giovannak/github-list

emotionjs github github-api javascript material-ui material-ui-5 nextjs progressive-web-app pwa react react-query reactjs ssr typescript

Last synced: 22 days ago
JSON representation

Github list is a web application which shows the profile and repositories information of a specific github user.

Host: GitHub
URL: https://github.com/giovannak/github-list
Owner: GiovannaK
Created: 2021-10-15T03:20:06.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-10-24T03:47:49.000Z (over 3 years ago)
Last Synced: 2024-11-19T02:56:23.524Z (3 months ago)
Topics: emotionjs, github, github-api, javascript, material-ui, material-ui-5, nextjs, progressive-web-app, pwa, react, react-query, reactjs, ssr, typescript
Language: TypeScript
Homepage: https://githublist.netlify.app/
Size: 798 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# 📃 GITHUBLIST

## SEE PREVIEW HERE: https://githublist.netlify.app/
---

![Project Image](public/githublist.png)

Description   |
Features   |
How to Use   |
License   |
Author Info

---

## Description
### Github list is a web application which shows the profile and repositories information of a specific github user

## Technologies

### Front-end
- React
- NextJS
- Typescript
- React-Query
- Material UI

# Features

## PROGRESSIVE WEB APP
- This application has PWA features

### Search user

- You can search by any github user

### Profile

- You can get the most important informations about user profile
- Name, username, company, blog, followers, followings, gists...

### Repos

- You can see all public repos
- repo name, repo full name and repo link

---
## ❗ How To Use

### Run locally

### Clone the project

```html
git clone https://github.com/GiovannaK/github-list
```
### Assuming you already have NodeJS and npm installed and properly configured: Run the command below to install all required dependencies

```html
npm install
```
### Finally you can run the project
```html
npm run dev
```

---

## 📌 License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---

## Author Info

- Linkedin - [Giovanna Cunha](https://www.linkedin.com/in/giovanna-cunha-4989b81b2/)