https://github.com/winterfulllll/repo-searcher

A repository search service based on the GitHub Rest API 🔎
https://github.com/winterfulllll/repo-searcher

github-rest-api material-ui mobx-react react-vite-typescript

Last synced: about 2 months ago
JSON representation

A repository search service based on the GitHub Rest API 🔎

• Host: GitHub
• URL: https://github.com/winterfulllll/repo-searcher
• Owner: Winterfulllll
• Created: 2024-10-27T08:55:15.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T21:56:43.000Z (7 months ago)
• Last Synced: 2025-01-30T06:29:03.278Z (4 months ago)
• Topics: github-rest-api, material-ui, mobx-react, react-vite-typescript
• Language: TypeScript
• Homepage: https://winterfulllll.github.io/Repo-Searcher/
• Size: 885 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [RepoSearcher 🔎](https://winterfulllll.github.io/Repo-Searcher/)

## Описание 💡

Сервис поиска репозиториев на базе [GitHub Rest API](https://docs.github.com/en/rest)

### Технологический стек ⚙️

- **Main stack:** [Vite](https://vite.dev/) + [React](https://react.dev/) + [TS](https://www.typescriptlang.org/)

- **State manager:** [MobX](https://mobx.js.org)

- **React UI Component Library:** [Material UI](https://mui.com/)

- **Testing:** [Jest](https://jestjs.io) + [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/)

### Реализованные фичи ✨

- [x] Поиск репозиториев с плавной прогрузкой данных

- [x] Сортировка по трём критериям в определенном порядке

- [x] Локальное редактирование и удаление полученных от API данных

- [x] Тестирование unit-тестами

### Возможные улучшения 🧠

- [ ] Темы (_тёмная/светлая_)

- [ ] Расширение параметров для поиска (подробнее [_здесь_](https://docs.github.com/en/search-github/searching-on-github/searching-code))

- [ ] Добавить OAuth для увеличения количества запросов

## Техническое задание ✅

Необходимо получить с сервера и отобразить список элементов. Список должен поддерживать бесконечный плавный скролл, постепенную подгрузку элементов, локальное удаление и редактирование.

### Требования 🎯

- **Обязательно использование:** TS, React/MobX, CSS-модули, Webpack/Vite, Jest, React Testing Library;

- **API:** Для получения списка нужно использовать публичный API какого-либо сервиса: github api, npmjs api, imdb api и др. Важно, чтобы список данных был очень большим с возможностью пагинации. Например:

  ```

  $ curl "https://api.github.com/search/repositories?q=javascript&sort=stars&order=asc&page=2"

  ```

- **Аутентификация:** Добавить аутентификацию, если требует API;

- **Работа с API:** Работать с API можно через библиотеку, либо делать запросы напрямую;

- **Механика отображения:** Механику отображения и работу со списком необходимо написать самостоятельно. Нельзя использовать готовую библиотеку;

- **Локальное редактирование:** Нужна возможность редактировать и удалять элементы из списка локально (работа со стором);

- **Дизайн:** Требований к дизайну нет. Для отображения списка необходимо использовать любой UI Kit/Framework, например Ant Design. Обосновать свой выбор.

- **Тестирование:** Функциональность покрыть unit-тестами на Jest + React Testing Library.

#### Желательно 😎

- **Сортировка:** Поддержать сортировку списка по разным полям, если поддерживает API;

- **Индикация загрузки:** Добавить индикацию подгрузки данных.

## Вывод 🤔

В результате проделанной работы мне удалось:

- Выстроить гармоничный технологический стек

- Реализовать все запланированные основные фичи

- Сделать целостный pet-проект

### Примечание

В качестве _UI библиотеки_ мной был выбран `Material UI`, так как ранее с ним не работал и хотелось пощупать что-то новое. Кроме того, он является крайне популярным и хорошо поддерживаемым решением.