React & React Native/환경 설정 및 구성

[RN] React Native 환경에서 react-native-boilerplate Template 이해하고 구성하기 -1 : 프로젝트 실행 및 디렉터리 구조 확인

adjh54 2024. 11. 23. 15:36
반응형
해당 글에서는 thecodingmachine/react-native-boilerplate를 활용하여 React Native의 템플릿을 활용하는 방법과 각각의 디렉터리별 구조를 확인합니다.


 

1) react-native-boilerplate


💡 react-native-boilerplate

- React Native 애플리케이션 개발을 위한 초기 프로젝트 템플릿입니다. 프로젝트를 최초 생성할 때, 해당 react-native-boilerplate를 활용하여서 기본 틀이 되는 구조를 받아서 구성합니다.
 

GitHub - thecodingmachine/react-native-boilerplate: A React Native template for building solid applications 🐙, using JavaScri

A React Native template for building solid applications 🐙, using JavaScript 💛 or Typescript 💙 (you choose). - thecodingmachine/react-native-boilerplate

github.com

 

 

Light Simple and Scalable The React Native Boilerplate by TheCodingMachine | The React Native Boilerplate

A React Native template for building solid applications, using JavaScript or Typescript (YOU choose).

thecodingmachine.github.io

 

 

[ 더 알아보기 ]

💡 보일러플레이트(Boilerplate)

- 최소한의 변경으로 재사용할 수 있는 프로그램 코드나 문서의 템플릿을 의미합니다.
- 즉, 이를 사용하면 프로젝트 설정, 폴더 구조, 기본 기능 구현 등을 처음부터 직접 작성할 필요 없이, 검증된 구조와 설정을 바로 사용할 수 있어 개발 시간을 크게 단축할 수 있습니다

- 프로젝트를 시작할 때 필요한 기본 구조와 설정을 미리 갖춘 템플릿자주 사용되는 코드나 기능들이 미리 구현되어 있는 기초 프레임워크개발자가 새 프로젝트를 빠르게 시작할 수 있도록 도와주는 초기 코드 세트입니다.

 

1. react-native-boilerplate 주요 특징


💡 react-native-boilerplate 주요 특징
주요 특징 설명
Javascript or TypeScript 모든 프로젝트와 개발팀의 상황이 다르기 때문에, 자바스크립트나 타입스크립트 중 원하는 언어를 선택할 수 있습니다.
Navigation React Navigation을 통해 앱의 화면 이동을 쉽게 구현할 수 있습니다.
Data fetching️ TanStack Query를 사용하여 서버와의 데이터 통신을 간편하게 처리할 수 있습니다.
Internationalization React i18next를 통해 여러 언어를 쉽게 지원할 수 있습니다.
Multi theming 추가 설치 없이도 앱의 테마를 쉽게 관리하고 변경할 수 있습니다.
Safe synchrone storage React Native MMKV를 이용해 앱 내 데이터를 안전하고 빠르게 저장할 수 있습니다.
Environment 환경 변수 관리에 필요한 모든 도구가 미리 설정되어 있습니다.

 

 

Introduction | The React Native Boilerplate

Welcome to the React Native Boilerplate documentation!

thecodingmachine.github.io

 

 

2. react-native-boilerplate 타겟 버전


💡 react-native-boilerplate 타겟 버전

- 해당 템플릿을 이용하여 React Native를 실행하기 위해서는 아래의 버전이 요구가 됩니다.
- 현재 버전은 4.3.1 버전을 기준으로 작성을 하였습니다.

https://github.com/thecodingmachine/react-native-boilerplate

타겟  최소 버전
node 18 이상
XCode 10 이상
iOS 11 이상

 

 

3. react-native-boilerplate 주요 라이브러리


💡 react-native-boilerplate 주요 라이브러리

- 해당 Template에서 기본적으로 제공하는 주요 라이브러리는 아래와 같습니다.
- 해당 버전은 4.3.1 버전이 기준입니다.

https://thecodingmachine.github.io/react-native-boilerplate/docs/getting-started/

라이브러리 버전 설명
@react-native-masked-view/masked-view 0.3.1 부분적으로 콘텐츠를 마스킹하거나 클리핑할 수 있는 뷰 컴포넌트를 제공
@react-navigation/native, @react-navigation/stack 6.1.x React Native 앱의 화면 전환과 네비게이션을 관리하는 라이브러리
@tanstack/react-query 5.59.8 서버 상태 관리 및 데이터 페칭을 위한 강력한 라이브러리
i18next, react-i18next 23.15.2, 15.0.2 다국어 지원을 위한 국제화(i18n) 라이브러리
intl-pluralrules 2.0.1 다국어 복수형 규칙을 지원하는 라이브러리
ky 1.7.2 HTTP 요청을 위한 경량 라이브러리
react, react-native 18.3.1, 0.76.1 React Native 앱 개발을 위한 핵심 라이브러리
react-error-boundary 4.0.13 React 애플리케이션의 에러 처리를 위한 컴포넌트
react-native-gesture-handler 2.20.0 터치 제스처 처리를 위한 라이브러리
react-native-mmkv 3.1.0 빠른 키-값 저장소 라이브러리
react-native-reanimated 3.15.4 고성능 애니메이션을 위한 라이브러리
react-native-safe-area-context 4.11.0 안전 영역(노치, 홈 인디케이터 등)을 처리하는 라이브러리
react-native-screens 4.0.0 네이티브 네비게이션을 최적화하는 라이브러리
react-native-svg 15.7.1 SVG 이미지 사용을 위한 라이브러리
zod 3.23.8 TypeScript 기반의 스키마 검증 라이브러리

 

 

 

4. react-native-boilerplate 프로젝트 구조


 

폴더 주요 라이브러리 설명
src/components - 프레젠테이션 구성 요소를 구성하기 위한 원자 설계 방법론을 따르는 애플리케이션 구성 요소의 홈입니다.
src/hooks @tanstack/react-query 애플리케이션 전반에 사용자 정의 훅(hook)가 사용됩니다.
src/navigation @react-navigation/native,
@react-navigation/stack
탐색 처리(페이지 이동)를 담당하는 탐색 구성 요소입니다.
src/screens - 다양한 앱 화면을 나타내는 화면 구성 요소입니다.
src/services️ ky 주택 데이터 수집 및 관련 서비스.
src/theme   애플리케이션에 대한 테마 구성을 보관합니다.
src/translations i18next, react-i18next 언어 지원(다국어)과 관련된 구성입니다.

 

[ 더 알아보기 ]

💡 원자 설계 방법론(Atomic Design) 중 Atoms (원자)은 무엇을 의미하는가?


- 버튼, 입력 필드, 레이블과 같은 가장 기본적인 UI 요소들을 분리하는 방식을 의미합니다.
1. 재사용성 향상: 작은 컴포넌트부터 체계적으로 구성하여 재사용이 용이
2. 일관성 유지: 동일한 디자인 패턴을 유지하기 쉬움
3. 유지보수 용이: 컴포넌트 단위로 관리되어 수정이 쉬움
4. 개발 효율성: 컴포넌트 기반 개발로 작업 효율성 증가

 

 

3) 프로젝트 구조 상세 파악 하기


 

1. index.js


💡 index.js

- 해당 페이지에서는 app.json 파일 내에 name을 가져와서 App 이름으로 지정하고 있습니다.
- 개발 환경인 경우 ‘reactotron-react-native’ 라이브러리를 이용하여 모니터링하고 디버깅을 수행함을 확인하였습니다.
import { AppRegistry } from 'react-native';

import { name as appName } from './app.json';
import App from './src/App';

if (__DEV__) {
  import('@/reactotron.config');
}

AppRegistry.registerComponent(appName, () => App);

 

 

[ 더 알아보기 ]

💡 Reactotron


- React 및 React Native 애플리케이션을 위한 디버깅 도구입니다.
- 이를 통해 개발자들이 앱의 동작을 실시간으로 모니터링하고 디버깅할 수 있도록 합니다.
 

Reactotron | Open Source at Infinite Red

What is Reactotron?

docs.infinite.red

 

2. App.tsx


💡 App.tsx

1. import '@/translations'
- 다국어 지원을 위한 i18n 라이브러리 설정으로, JSON 파일을 통해 각 언어별 번역을 관리할 수 있습니다.

2. QueryClientProvider
- @tanstack/react-query를 사용하여 서버 상태 관리와 데이터 페칭을 처리합니다. 코드에서는 mutations와 queries에 대해 retry 옵션을 false로 설정하여 실패 시 재시도를 하지 않도록 구성되어 있습니다.

3. ThemeProvider
- 앱의 테마 관리를 담당하는 컴포넌트입니다. MMKV 스토리지와 함께 사용되어 테마 설정을 저장하고 관리합니다.

4. ApplicationNavigator
- 앱의 내비게이션 구조를 정의하고 관리하는 컴포넌트로, 화면 간의 이동과 라우팅을 처리합니다.
import 'react-native-gesture-handler';

import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { GestureHandlerRootView } from 'react-native-gesture-handler';
import { MMKV } from 'react-native-mmkv';

import { ThemeProvider } from '@/theme';
import ApplicationNavigator from '@/navigation/Application';

import '@/translations';

export const queryClient = new QueryClient({
  defaultOptions: {
    mutations: {
      retry: false,
    },
    queries: {
      retry: false,
    },
  },
});

export const storage = new MMKV();

function App() {
  return (
    <GestureHandlerRootView>
      <QueryClientProvider client={queryClient}>
        <ThemeProvider storage={storage}>
          <ApplicationNavigator />
        </ThemeProvider>
      </QueryClientProvider>
    </GestureHandlerRootView>
  );
}

export default App;

 

 

 

3. ApplicationNavigator.tsx


💡 ApplicationNavigator.tsx

- react-navigation을 기반으로 라우팅 처리를 수행하는 페이지입니다.
- 해당 컴포넌트에서는 라우팅을 위한 이름을 지정하고 컴포넌트를 지정하여서 navigation을 통해 페이지를 이동하는 라우터 역할을 제공합니다.
import type { RootStackParamList } from '@/navigation/types';

import { NavigationContainer } from '@react-navigation/native';
import { createStackNavigator } from '@react-navigation/stack';
import { SafeAreaProvider } from 'react-native-safe-area-context';

import { useTheme } from '@/theme';
import { Paths } from '@/navigation/paths';

import { Example, Startup } from '@/screens';

const Stack = createStackNavigator<RootStackParamList>();

function ApplicationNavigator() {
  const { navigationTheme, variant } = useTheme();

  return (
    <SafeAreaProvider>
      <NavigationContainer theme={navigationTheme}>
        <Stack.Navigator key={variant} screenOptions={{ headerShown: false }}>
          <Stack.Screen component={Startup} name={Paths.Startup} />
          <Stack.Screen component={Example} name={Paths.Example} />
        </Stack.Navigator>
      </NavigationContainer>
    </SafeAreaProvider>
  );
}

export default ApplicationNavigator;

 

 

4. Example.tsx


💡 Example.tsx

- 해당 컴포넌트에서는 다국어 지원, 테마 관리, 사용자 데이터 조회의 주요 기능들을 포함하고 있습니다.

1. useTranslation(), useI18n() hook을 통해 공통으로 구성된 다국어 지원 기능이 구현되어 있습니다.

2. useTheme() hook을 통해 공통으로 구성된 다크/라이트 테마 전환 기능이 구현되어 있습니다.

3. useFetchOneQuery() hook을 통해 공통으로 구성된 API 통신을 위한 랜덤 한 사용자 ID로 데이터를 조회하고, 성공 시 Alert로 사용자 이름을 표시합니다

4. 렌더링 되는 화면에서는 ‘사용자 데이터 조회 버튼’, ‘테마 변경 버튼’, ‘언어 변경 버튼’이 적용되어 있습니다.
import { useEffect, useState } from 'react';
import { useTranslation } from 'react-i18next';
import { Alert, ScrollView, Text, TouchableOpacity, View } from 'react-native';

import { useTheme } from '@/theme';
import { useI18n, useUser } from '@/hooks';

import { AssetByVariant, IconByVariant, Skeleton } from '@/components/atoms';
import { SafeScreen } from '@/components/templates';

const Example = () => {
  const { t } = useTranslation();
  const { useFetchOneQuery } = useUser();
  const { toggleLanguage } = useI18n();

  const {
    backgrounds,
    changeTheme,
    colors,
    components,
    fonts,
    gutters,
    layout,
    variant,
  } = useTheme();

  const [currentId, setCurrentId] = useState(-1);

  const fetchOneUserQuery = useFetchOneQuery(currentId);

  useEffect(() => {
    if (fetchOneUserQuery.isSuccess) {
      Alert.alert(
        t('screen_example.hello_user', { name: fetchOneUserQuery.data.name }),
      );
    }
  }, [fetchOneUserQuery.isSuccess, fetchOneUserQuery.data, t]);

  const onChangeTheme = () => {
    changeTheme(variant === 'default' ? 'dark' : 'default');
  };

  return (
    <SafeScreen
      isError={fetchOneUserQuery.isError}
      onResetError={fetchOneUserQuery.refetch}
    >
      <ScrollView>
        <View
          style={[
            layout.justifyCenter,
            layout.itemsCenter,
            gutters.marginTop_80,
          ]}
        >
          <View
            style={[layout.relative, backgrounds.gray100, components.circle250]}
          />

          <View style={[layout.absolute, gutters.paddingTop_80]}>
            <AssetByVariant
              path={'tom'}
              resizeMode={'contain'}
              style={{ height: 300, width: 300 }}
            />
          </View>
        </View>

        <View style={[gutters.paddingHorizontal_32, gutters.marginTop_40]}>
          <View style={[gutters.marginTop_40]}>
            <Text style={[fonts.size_40, fonts.gray800, fonts.bold]}>
              {t('screen_example.title')}
            </Text>
            <Text
              style={[fonts.size_16, fonts.gray200, gutters.marginBottom_40]}
            >
              {t('screen_example.description')}
            </Text>
          </View>

          <View
            style={[
              layout.row,
              layout.justifyBetween,
              layout.fullWidth,
              gutters.marginTop_16,
            ]}
          >
            <Skeleton
              height={64}
              loading={fetchOneUserQuery.isLoading}
              style={{ borderRadius: components.buttonCircle.borderRadius }}
              width={64}
            >
              <TouchableOpacity
                onPress={() => setCurrentId(Math.ceil(Math.random() * 9 + 1))}
                style={[components.buttonCircle, gutters.marginBottom_16]}
                testID="fetch-user-button"
              >
                <IconByVariant path={'send'} stroke={colors.purple500} />
              </TouchableOpacity>
            </Skeleton>

            <TouchableOpacity
              onPress={onChangeTheme}
              style={[components.buttonCircle, gutters.marginBottom_16]}
              testID="change-theme-button"
            >
              <IconByVariant path={'theme'} stroke={colors.purple500} />
            </TouchableOpacity>

            <TouchableOpacity
              onPress={toggleLanguage}
              style={[components.buttonCircle, gutters.marginBottom_16]}
              testID="change-language-button"
            >
              <IconByVariant path={'language'} stroke={colors.purple500} />
            </TouchableOpacity>
          </View>
        </View>
      </ScrollView>
    </SafeScreen>
  );
}

export default Example;

 

 

 

 

4) 프로젝트 생성 및 실행


💡 프로젝트 생성 및 실행

- 최초 프로젝트 생성을 위한 각각 설치 프로그램이 설치되었다는 가정하에 수행합니다.

 

 

💡 [참고] 아래의 글을 통해서 기본적은 React Native 실행을 위한 설치에 대해 참고하시면 도움이 됩니다.
 

[RN] React-native-cli Mac OS 환경설정 : 초기 프로젝트 구성

해당 글은 Mac OS 기반의 React-native-cli 기반 환경설정 방법입니다. 1) 필수 프로그램을 설치합니다.1. homebrew💡 macOS 용 패키지 관리자입니다. HomebrewThe Missing Package Manager for macOS (or Linux).brew.sh # 설

adjh54.tistory.com

 

1. 명령어 수행


명령어 구성요소 설명
npx @react-native-community/cli@latest React Native CLI의 최신 버전을 사용하여 프로젝트 초기화
init [프로젝트명] ‘[프로젝트명]’라는 이름의 새 프로젝트 생성
--template @thecodingmachine/react-native-boilerplate thecodingmachine의 React Native 보일러플레이트 템플릿 적용
$ npx @react-native-community/cli@latest init hundred3 --template @thecodingmachine/react-native-boilerplate
 

GitHub - thecodingmachine/react-native-boilerplate: A React Native template for building solid applications 🐙, using JavaScri

A React Native template for building solid applications 🐙, using JavaScript 💛 or Typescript 💙 (you choose). - thecodingmachine/react-native-boilerplate

github.com

 

💡 아래와 같이 수행이 되었음을 확인하였습니다.

 

 

 

2. 프로젝트를 열고 확인합니다.


 💡 프로젝트를 열고 확인합니다.

- 아래와 같이 package-lock.json 파일과 yarn.lcok 파일이 존재하기에 패키지 매니저 인 npm 또는 yarn을 통해서 라이브러리를 설치해 줍니다.

 

 

3. 내부 라이브러리 설치


 💡 내부 라이브러리 설치

- 패키지 매니저인 yarn을 기반으로 설치를 하였습니다.

 

 

4. 실행하기


 💡 실행하기

- package.json 내에 정의된 스크립트를 기반으로 수행합니다.

 

💡 yarn android를 통해서 빌드를 수행하였습니다.
# 프로젝트 실행
$ yarn android

 

 

 

5) 실행 결과 확인


 💡 실행 결과 확인

- 아래와 같이 앱이 생성되었고, 실행이 잘됨을 확인하였습니다.

 

💡 아래와 같이 앱이 실행됨을 확인하였습니다.

 

 

 

 

오늘도 감사합니다.😀

 

 

 

 

반응형