Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
marekzelinka committed Dec 5, 2024
2 parents c8e3a6b + edc8804 commit 17d9e5c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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/).
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

Expand All @@ -13,7 +13,7 @@ This project is a simple GitHub user search app. It's written in [TypeScript](ht
2. Install the dependencies:

```sh
npm i
pnpm i
```

3. Define required env variables:
Expand All @@ -24,12 +24,12 @@ This project is a simple GitHub user search app. It's written in [TypeScript](ht
4. Run the application in dev mode:

```sh
npm run dev
pnpm 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).
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

Expand Down

0 comments on commit 17d9e5c

Please sign in to comment.