# skelly-app

> Utilities to integrate with Skelly

Latest version **1.0.29** (published 2023-11-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install skelly-app
pnpm add skelly-app
yarn add skelly-app
bun add skelly-app
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.29 |
| Published | 2023-11-05 |
| First published | 2023-08-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 34.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Skelly.gg |
| Maintainers | skelly-app |
| Keywords | Skelly, Integration, GraphQL, React |

## Links

- npm: https://www.npmjs.com/package/skelly-app
- Repository: https://github.com/Skelly-gg/skelly-app
- Homepage: https://skelly.gg
- Issues: https://github.com/Skelly-gg/skelly-app/issues
- npm.io page: https://npm.io/package/skelly-app

## Dependencies (6)

- [axios](https://npm.io/package/axios.md) ^1.4.0
- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [@mui/material](https://npm.io/package/@mui/material.md) ^5.14.5
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.11.1
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^11.11.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.29 (latest) — 2023-11-05
- 1.0.28 — 2023-09-02
- 1.0.27 — 2023-08-29
- 1.0.26 — 2023-08-29
- 1.0.25 — 2023-08-29
- 1.0.24 — 2023-08-25
- 1.0.23 — 2023-08-25
- 1.0.22 — 2023-08-24
- 1.0.21 — 2023-08-19
- 1.0.20 — 2023-08-19
- 1.0.19 — 2023-08-19
- 1.0.18 — 2023-08-19
- 1.0.17 — 2023-08-16
- 1.0.12 — 2023-08-15
- 1.0.11 — 2023-08-15
- … 10 more at https://npm.io/package/skelly-app/versions

## README

# skelly-app

Library allowing your to easily integrate your services with [Skelly](https://skelly.gg).

# Installation

Installing the package using npm:

```
npm install skelly-app
```

Installing the repository using git and launching the demo react app:

```
git clone https://github.com/Skelly-gg/skelly-app.git

cd skelly-app

npm install

npm run demo

start .\dist\index.html
```

You can also play with the online [demo](https://skelly.gg/demo).

# Integration

## GraphQL

Here is how you can fetch profiles using GraphQL:

```
import { getProfile, getProfiles } from "skelly-app";

const profile = await getProfile("N0tail");
console.log(profile)

const profiles = await getProfiles(["Keria", "12728"])
console.log(profiles)
```

## React

You can also easily integrate profiles into your React application using our out-of-the-box component:

```
import {Profile} from "skelly-app";

export function App() {
  const { fetchProfile, accountId, loadingProfile, profile, errorProfile } =
    useFetchProfile();

  React.useEffect(() => {
    fetchProfile("S1mple");
  }, []);

  if (profile) return <Profile profile={profile} />;
  else return <div>Loading profile...</div>;
}
```

## Utilities

There are convenient utility functions available to process Skelly profiles:

```
import { getProfile, getAvatar, getName, getLongName } from "skelly-app";

const profile = await getProfile("N0tail");

const avatarURL = getAvatar(profile)
console.log(avatarURL)

const name = getName(profile)
console.log(name)

const longName = getLongName(profile)
console.log(longName)
```

---
_Source: https://npm.io/package/skelly-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._