https://github.com/marekzelinka/devfinder
Search GitHub users
https://github.com/marekzelinka/devfinder
github-graphql-api graphql heroicons react react-router-v7 tailwindcss typescript
Last synced: 5 months ago
JSON representation
Search GitHub users
- Host: GitHub
- URL: https://github.com/marekzelinka/devfinder
- Owner: marekzelinka
- Created: 2024-08-20T12:07:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-05T09:35:57.000Z (10 months ago)
- Last Synced: 2025-03-05T10:32:28.415Z (10 months ago)
- Topics: github-graphql-api, graphql, heroicons, react, react-router-v7, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://user-search.fly.dev/
- Size: 1000 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DevFinder
This project is a simple search app for GitHub users. It's written in [TypeScript](https://www.typescriptlang.org/) and uses [React](https://react.dev/), [React Router](https://reactrouter.com/) and [Tailwind CSS](https://tailwindcss.com/). I've deployed it on [Fly.io](https://fly.io/).
## Get started
1. Clone the repository:
```sh
git clone https://github.com/marekzelinka/devfinder.git
```
2. Install the dependencies:
```sh
pnpm 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
pnpm dev
```
## Goals
Practice working with Remix [data loadings APIs](https://remix.run/docs/en/main/guides/data-loading) and using third-party APIs, like [GitHub GraphQL API](https://docs.github.com/en/graphql).
## Credits
- Challenge by [Frontend Mentor](https://www.frontendmentor.io/challenges/devfinder-app-Q09YOgaH6)