https://github.com/flippercorporation/nachocode-client-sdk

Nachocode Client SDK
https://github.com/flippercorporation/nachocode-client-sdk
android app-development ios low-code nachocode react sdk
Last synced: about 2 months ago
JSON representation
Nachocode Client SDK
Host: GitHub
URL: https://github.com/flippercorporation/nachocode-client-sdk
Owner: FlipperCorporation
License: mit
Created: 2025-03-25T05:35:36.000Z (about 2 months ago)
Default Branch: main
Last Pushed: 2025-03-25T13:08:14.000Z (about 2 months ago)
Last Synced: 2025-03-25T14:23:26.928Z (about 2 months ago)
Topics: android, app-development, ios, low-code, nachocode, react, sdk
Language: TypeScript
Homepage: https://developer.nachocode.io
Size: 173 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # 📦 nachocode Client SDK



  





  



> 🔔 **최신화 일자:** _2025-03-25_

## 목차

- [📦 nachocode Client SDK](#-nachocode-client-sdk)

  - [목차](#목차)

  - [개요](#개요)

  - [설치](#설치)

  - [사용법](#사용법)

    - [1️⃣ `NachoProvider` (React Context 방식)](#1️⃣-nachoprovider-react-context-방식)

      - [`useNachocode()` 반환값](#usenachocode-반환값)

    - [2️⃣ `loadNachocode` 직접 사용](#2️⃣-loadnachocode-직접-사용)

  - [SDK 초기화 옵션 (`InitializeOptions`)](#sdk-초기화-옵션-initializeoptions)

  - [SDK 버전 관리](#sdk-버전-관리)

  - [SDK 기능 사용](#sdk-기능-사용)

  - [네임스페이스 소개](#네임스페이스-소개)

  - [라이선스](#라이선스)

  - [기여자](#기여자)

  - [마무리](#마무리)

---

## 개요

**nachocode Client SDK**는 **웹 개발자들이 네이티브 앱의 고유 기능을 손쉽게 활용할 수 있도록 돕는 SDK**입니다.

이 문서는 **SDK의 설치, 초기화, 주요 기능 및 사용 방법** 등을 안내합니다.

- [공식 문서 바로가기](https://developer.nachocode.io/docs/sdk/intro)

---

## 설치

```bash

npm install nachocode-client-sdk

```

또는

```bash

yarn add nachocode-client-sdk

```

---

## 사용법

nachocode Client SDK는 두 가지 방법으로 사용할 수 있습니다.

### 1️⃣ `NachoProvider` (React Context 방식)

- 애플리케이션 전체에서 `Nachocode`를 사용할 수 있도록 `Provider` 패턴을 제공합니다.

- `useNachocode` 훅을 사용하여 `Nachocode` 객체에 접근할 수 있습니다.

```jsx

import { NachoProvider, useNachocode } from 'nachocode-client-sdk';

function MyComponent() {

  const { Nachocode, loading, error } = useNachocode();

  if (loading) return 
Loading...;

  if (error) return Error: {error.message}
;

  return 
Nachocode SDK 사용 가능!;

}

export default function App() {

  return (

    

      

    

  );

}

```

#### `useNachocode()` 반환값

| 반환값      | 설명                                          |

| ----------- | --------------------------------------------- |

| `Nachocode` | Nachocode SDK 객체                            |

| `loading`   | SDK 로딩 상태 (`true` 또는 `false`)           |

| `error`     | SDK 로드 중 발생한 에러 (`Error` 또는 `null`) |

### 2️⃣ `loadNachocode` 직접 사용

- React 외부에서도 `loadNachocode` 함수를 직접 호출하여 사용 가능합니다.

```jsx

import { loadNachocode } from 'nachocode-client-sdk';

async function initSDK() {

  try {

    const Nachocode = await loadNachocode('your-api-key-here');

    console.log('Nachocode SDK 로드 완료:', Nachocode);

  } catch (error) {

    console.error('Nachocode SDK 로드 실패:', error);

  }

}

initSDK();

```

---

## SDK 초기화 옵션 (`InitializeOptions`)

nachocode Client SDK는 초기화 시 선택적으로 옵션을 설정할 수 있습니다.

초기화 옵션은 `NachoProvider`, `loadNachocode` 두 방식에서 모두 사용할 수 있습니다.

1. `NachoProvider` 방식에서 `options` 사용

   - `NachoProvider`에 `apiKey`와 함께 `options`를 전달할 수 있습니다:

   ```jsx

   

     

   

   ```

2. `loadNachocode` 직접 호출 시 `options` 사용

   - 비 React 환경 또는 수동으로 초기화하고 싶을 때 사용합니다:

   ```jsx

   loadNachocode('your-api-key', {

     sandbox: true,

     logger: true,

   });

   ```

| 옵션 이름 | 타입    | 설명                                                                 |

| --------- | ------- | -------------------------------------------------------------------- |

| `sandbox` | boolean | ✅ 샌드박스 환경에서 테스트 시 `true`로 설정                         |

| `logger`  | boolean | ✅ 콘솔 로그를 통해 SDK 내부 동작을 디버깅하고 싶을 때 `true`로 설정 |

- `logger`는 기본적으로 true로 설정되어 있으며, 개발 중 디버깅에 유용합니다.

- `sandbox`는 실제 운영 API가 아닌 테스트 서버를 사용하는 경우 유용합니다.

---

## SDK 버전 관리

최신 버전 로드 (기본)

- 최신 버전의 SDK를 항상 유지하려면 아래 코드를 사용하세요

- 현재 최신 버전 v.1.4.2

```jsx

loadNachocode('your-api-key'); // 최신 버전이 자동으로 로드됨

```

특정 버전 지정

- 특정 버전으로 고정하려면 다음과 같이 사용합니다

```jsx

loadNachocode('your-api-key', options, '1.4.2');

```

> 📢 최신 버전 사용이 권장되며, 특정 버전 고정은 호환성이 중요한 경우에만 사용하세요.

---

## SDK 기능 사용

- nachocode Client SDK가 초기화가 완료되면, `Nachocode` 네임스페이스 아래에 정의된 다양한 네이티브 기능을 사용할 수 있습니다.

- 아래 예시는 SDK의 일부 기능을 사용하는 방법을 보여줍니다.

  - **앱 정보 가져오기**

  ```jsx

  const appName = Nachocode.app.getAppName();

  console.log(`앱 이름: ${appName}`); // ex. "Nachocode Developer"

  ```

  - **디바이스 정보 확인**

  ```jsx

  Nachocode.device.getDeviceModel(model => {

    console.log(`디바이스 모델: ${model}`);

  });

  ```

- 대부분의 기능은 웹 실행환경에선 무시되고, 앱 실행환경에서 정상 작동합니다.

---

## 네임스페이스 소개

nachocode Client SDK는 각 기능별로 **네임스페이스(namespace)** 로 구분되어 있습니다.

아래는 주요 네임스페이스의 목록과 설명입니다. 각 네임스페이스에 대한 상세한 문서는 **문서 링크**에서 확인하세요.

| **네임스페이스** | **설명**                                                                         | **문서 링크**                                                                             |

| ---------------- | -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |

| `app`            | 앱 이름, 버전, 패키지 이름 등의 정보를 제공합니다.                               | [앱 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/app)                 |

| `apple`          | Apple 계정을 통한 소셜 로그인 기능 등을 제공합니다.                              | [Apple 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/apple)            |

| `authentication` | 생체 인증(Fingerprint/Face ID) 등의 기능을 제공합니다.                           | [인증 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/authentication)    |

| `backkey`        | Android 디바이스의 네이티브 백 키 이벤트를 제어할 수 있습니다.                   | [백 키 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/backkey)          |

| `browser`        | 외부 또는 내부 브라우저로 URL을 열 수 있습니다.                                  | [브라우저 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/browser)       |

| `clipboard`      | 텍스트를 클립보드에 복사하거나 읽을 수 있습니다.                                 | [클립보드 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/clipboard)     |

| `device`         | 디바이스 모델, OS 버전, 배터리 및 네트워크 상태 등을 확인합니다.                 | [디바이스 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/device)        |

| `env`            | SDK 초기화 상태, 실행 환경(웹/앱) 등을 확인할 수 있습니다.                       | [환경 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/env)               |

| `event`          | 초기화, 포그라운드/백그라운드 전환, 네트워크 상태 변경 등의 이벤트를 처리합니다. | [이벤트 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/event)           |

| `facebook`       | Facebook 소셜 로그인 기능을 제공합니다.                                          | [Facebook 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/facebook)      |

| `iap`            | Google Play 및 Apple App Store 인앱 결제 기능을 제공합니다.                      | [인앱 결제 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/iap)          |

| `permission`     | 카메라, 위치, 푸시 알림 등 디바이스 권한을 요청하고 상태를 확인할 수 있습니다.   | [권한 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/permission)        |

| `preference`     | 애플리케이션 내부 저장소를 통해 데이터를 저장 및 관리합니다.                     | [내부 저장소 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/preference) |

| `push`           | 푸시 알림 토큰을 관리하고 Nachocode 서버에 등록할 수 있습니다.                   | [푸시 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/push)              |

| `scanner`        | QR 코드 스캔 및 기타 스캔 기능을 제공합니다.                                     | [스캐너 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/scanner)         |

| `setting`        | Pull to Refresh와 같은 설정 기능을 제공합니다.                                   | [설정 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/setting)           |

| `share`          | 네이티브 공유 UI를 통해 URL을 공유할 수 있습니다.                                | [공유 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/share)             |

| `tabbar`         | 앱 내부 탭바의 표시 여부 및 이동을 제어할 수 있습니다.                           | [탭 바 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/tabbar)           |

| `vibration`      | 디바이스 진동 및 햅틱 피드백을 제어합니다.                                       | [진동 네임스페이스](https://developer.nachocode.io/docs/sdk/namespaces/vibration)         |

더 많은 네임스페이스와 사용법은 [공식 문서](https://developer.nachocode.io/docs/sdk/intro)를 확인하세요.

---

## 라이선스

이 프로젝트는 MIT 라이선스 하에 제공됩니다.

---

## 기여자

  

    

      

        


        _{Taekyu Park}

      

    

    

      

        


        _{John An}

      

    

  

## 마무리

nachocode Client SDK를 사용해주셔서 감사합니다! 🚀

궁금한 점이나 개선 사항이 있다면 [Issues](https://github.com/FlipperCorporation/nachocode-client-sdk/issues) 또는 [Pull Requests](https://github.com/FlipperCorporation/nachocode-client-sdk/pulls)를 통해 남겨주시거나,

언제든지 [[email protected]](mailto:[email protected])로 문의를 보내주세요. 🙌
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/flippercorporation/nachocode-client-sdk

Awesome Lists containing this project

README
