https://github.com/eureka-shoulders/fetchx

Beautiful way to fetch data in React
https://github.com/eureka-shoulders/fetchx

axios fetch http-client mobx react shoulders

Last synced: about 2 months ago
JSON representation

Beautiful way to fetch data in React

• Host: GitHub
• URL: https://github.com/eureka-shoulders/fetchx
• Owner: Eureka-Shoulders
• License: mit
• Created: 2021-11-22T20:00:58.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-19T05:57:28.000Z (over 1 year ago)
• Last Synced: 2024-11-16T17:03:23.578Z (about 2 months ago)
• Topics: axios, fetch, http-client, mobx, react, shoulders
• Language: TypeScript
• Homepage: https://eureka-shoulders.github.io/fetchx/
• Size: 1.08 MB
• Stars: 69
• Watchers: 3
• Forks: 6
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# FetchX

![npm](https://img.shields.io/npm/v/@euk-labs/fetchx)

![NPM](https://img.shields.io/npm/l/@euk-labs/fetchx)

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Eureka-Shoulders/fetchx/CI)

![npm](https://img.shields.io/npm/dw/@euk-labs/fetchx)

FetchX is a fetching library made for React built with [axios](https://github.com/axios/axios) and [mobx](https://github.com/mobxjs/mobx) that give you an easy way to handle CRUD of entities.

## Installation

Using npm:

```bash

npm i @euk-labs/fetchx mobx mobx-react-lite

```

Using yarn:

```bash

yarn add @euk-labs/fetchx mobx mobx-react-lite

```

### Dependencies

- Axios is used to fetch data from HTTP requests

- MobX is used to generate Stores and Hooks powered by these stores to make a beautiful reactive way to control the data on your interfaces.

## Usage

### `HttpService`

The HttpService is a class that will work as a wrapper for axios. It will handle all the requests and provide helpers to make your life easier.

### `Repository`

Repositories will abstract the CRUD operations of your entities. No state is stored in the repository, it only provides methods to fetch, create, update and delete entities.

### `ListStore`

ListStores are a set of states and actions built with MobX to handle a list of entities with resources like pagination, filters and inifinite scroll strategies.

They need a repository to work and know how to fetch the data.

Please read the MobX documentation to know more about the different ways to make your components reactive.

### `useList`

A hook to use the ListStore in your components. It will return the current state of the ListStore and the actions to interact with it.

Like ListStore, it needs a repository to work.

### `EntityStore`

In contrast with the ListStore, EntityStores can only handle a single entity. It can be used to fetch the entity by an identifier, update the loaded entity and delete it.

### `useEntity`

A hook to use the EntityStore in your components. It will return the current state of the EntityStore and the actions to interact with it.

Like EntityStore, it needs a repository to work.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)