Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marekzelinka/github-user-search
Search GitHub users
https://github.com/marekzelinka/github-user-search
github-graphql-api graphql heroicons react remix tailwindcss typescript
Last synced: 10 days ago
JSON representation
Search GitHub users
- Host: GitHub
- URL: https://github.com/marekzelinka/github-user-search
- Owner: marekzelinka
- Created: 2024-08-20T12:07:47.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-08-21T07:57:27.000Z (about 2 months ago)
- Last Synced: 2024-09-21T19:04:11.843Z (14 days ago)
- Topics: github-graphql-api, graphql, heroicons, react, remix, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://github-user-search-zeta-rouge.vercel.app
- Size: 541 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub User Search
This project is a simple GitHub user search app. It's written in [TypeScript](https://www.typescriptlang.org/), using [Remix](https://remix.run/), [React.js](https://react.dev/) and [Tailwind CSS](https://tailwindcss.com/). I've deployed this project on [Vercel](https://vercel.com/).
## Get started
1. Clone the repository:
```sh
git clone https://github.com/marekzelinka/github-user-search.git
```
2. Install the dependencies:
```sh
npm i
```
3. Define required env variables:
- Create a new [GitHub access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
- Copy the template contents in [.env.example](.env.example) to a new file named `.env` and fill all the required fields.
4. Run the application in dev mode:
```sh
npm run dev
```
## Goals
Practice working with Remix [data loadings APIs](https://remix.run/docs/en/main/guides/data-loading) and using a third-party APIs, like [GitHub GraphQL API](https://docs.github.com/en/graphql).
## Credits
- Challenge by [Frontend Mentor](https://www.frontendmentor.io/challenges/github-user-search-app-Q09YOgaH6)