How to Create a Basic CRUD App with StencilJS? A Comprehensive Tutorial

개요 이 가이드에서는 stenciljs를 사용하여 기본 crud(생성, 읽기, 업데이트 및 삭제) 애플리케이션을 구축하는 방법을 배웁니다 basic crud app stenciljs "라는 이름의 back4app 프로젝트를 시작하여 강력한 백엔드로 사용할 것입니다 그 후, 수동으로 또는 back4app ai 에이전트의 도움을 받아 컬렉션과 필드를 정의하여 확장 가능한 데이터베이스를 설계합니다 이 단계는 데이터베이스가 모든 crud 작업을 신뢰성 있게 지원하도록 맞춤화되도록 보장합니다 다음으로, 직관적인 드래그 앤 드롭 인터페이스인 back4app admin app을 사용하여 컬렉션을 원활하게 관리합니다 이 코드 없는 도구는 crud 작업 처리를 간소화합니다 마지막으로, stenciljs 프론트엔드를 rest/graphql api를 통해 back4app에 연결합니다 parse sdk도 사용 가능하지만, stenciljs에 완벽하게 적합한 api 통합에 집중하여 백엔드가 고급 액세스 제어를 통해 안전하게 유지되도록 합니다 이 튜토리얼이 끝나면 필수 crud 기능과 사용자 인증 및 강력한 데이터 관리를 지원하는 프로덕션 준비가 완료된 웹 애플리케이션을 갖게 됩니다 필수 통찰 신뢰할 수 있는 백엔드 시스템으로 crud 앱 구축 프로세스를 마스터하세요 확장 가능한 백엔드를 설계하고 이를 stenciljs 프론트엔드와 연결하는 방법을 이해하세요 효율적인 데이터 작업을 위해 코드 없는 관리 도구(back4app admin app)를 사용하는 방법을 배우세요 웹 애플리케이션을 신속하게 배포하기 위한 docker 컨테이너화 등 배포 전략을 알아보세요 필수 조건 시작하기 전에 다음을 확인하세요 활성 프로젝트가 있는 back4app 계정입니다 도움이 필요하신가요? back4app 시작하기 https //www back4app com/docs/get started/new parse app 를 확인하세요 stenciljs 개발 환경입니다 공식 stenciljs 문서 https //stenciljs com/docs/introduction 를 사용하여 환경을 설정하세요 node js(v14 이상)가 설치되어 있는지 확인하세요 javascript, 웹 컴포넌트 및 rest api에 대한 기본 지식입니다 필요한 경우 stenciljs 개념 https //stenciljs com/docs 을 복습하세요 1단계 – 프로젝트 시작하기 새 back4app 프로젝트 시작하기 back4app 계정에 로그인하세요 대시보드에서 “새 앱” 옵션을 선택하세요 프로젝트 이름을 지정하세요 basic crud app stenciljs 및 화면의 지침에 따라 설정을 완료하세요 새 프로젝트 만들기 설정이 완료되면, 프로젝트가 대시보드에 표시되어 백엔드 구성을 위한 견고한 기반을 제공합니다 2단계 – 데이터베이스 스키마 작성하기 데이터 모델 정의하기 이 crud 애플리케이션을 위해 여러 컬렉션을 설정해야 합니다 아래는 효율적인 crud 작업을 위해 데이터베이스 구조를 돕기 위한 샘플 컬렉션과 그 필드 및 데이터 유형입니다 1\ 수집 항목 이 수집은 각 항목에 대한 세부 정보를 포함합니다 필드 데이터 유형 세부사항 id 객체 id 자동 생성된 기본 키 제목 문자열 항목의 이름 또는 제목 설명 문자열 항목에 대한 간략한 설명 생성일 날짜 항목이 생성된 시간 업데이트됨 날짜 마지막 업데이트의 타임스탬프 2\ 수집 사용자 이 컬렉션은 사용자 프로필 및 인증을 관리합니다 필드 데이터 유형 세부사항 id 객체 id 자동 생성된 고유 식별자 사용자 이름 문자열 사용자를 위한 고유 식별자 이메일 문자열 고유한 이메일 주소 비밀번호 해시 문자열 인증을 위한 암호화된 비밀번호 생성일 날짜 계정 생성 타임스탬프 업데이트됨 날짜 사용자 계정의 마지막 업데이트 타임스탬프 back4app 대시보드에서 각 컬렉션에 대해 새 클래스를 생성하고 적절한 데이터 유형의 열을 추가하여 이러한 컬렉션을 수동으로 추가할 수 있습니다 새 클래스 만들기 프롬프트에 따라 데이터 유형을 선택하고, 필드 이름을 지정하고, 기본값을 설정하며, 필드가 필수인지 여부를 표시하세요 열 만들기 스키마 생성을 위한 back4app ai 에이전트 활용하기 back4app ai 에이전트는 간단한 프롬프트를 기반으로 데이터베이스 스키마 생성을 자동화하는 대시보드 내의 혁신적인 도구입니다 이 기능은 프로젝트 설정 속도를 높이고 스키마가 애플리케이션 요구 사항에 맞도록 보장합니다 ai 에이전트를 활용하는 방법 ai 에이전트에 접근하기 back4app 대시보드를 열고 메뉴 또는 프로젝트 설정에서 ai 에이전트를 찾으세요 스키마 요구 사항 입력하기 필요한 컬렉션과 필드를 설명하는 자세한 프롬프트를 제공하세요 검토 및 확인 ai 에이전트가 프롬프트를 처리한 후, 생성된 스키마 제안을 검토하고 프로젝트에 적용하세요 샘플 프롬프트 create these collections in my back4app project 1\) collection items \ fields \ id objectid (auto generated) \ title string \ description string \ created at date (auto generated) \ updated at date (auto updated) 2\) collection users \ fields \ id objectid (auto generated) \ username string (unique) \ email string (unique) \ password hash string \ created at date (auto generated) \ updated at date (auto updated) 이 방법은 스키마가 일관되고 최적화되어 있음을 보장합니다 3단계 – 관리자 앱 및 crud 기능 활성화 관리자 앱 소개 back4app 관리자 앱은 백엔드 데이터를 관리하기 쉽게 만들어주는 코드 없는 인터페이스를 제공합니다 직관적인 드래그 앤 드롭 시스템을 통해 모든 crud 작업—생성, 읽기, 업데이트 및 삭제—를 쉽게 수행할 수 있습니다 관리자 앱 활성화 “더보기” 메뉴를 열기 back4app 대시보드에서 “관리자 앱” 선택하기 그리고 “관리자 앱 활성화 ” 관리자 자격 증명 설정하기 관리자를 생성하여 이 과정은 b4aadminuser 와 시스템 컬렉션과 같은 기본 역할도 구성합니다 관리자 앱 활성화 활성화되면, 데이터 관리를 시작하기 위해 관리자 앱에 로그인하세요 관리자 앱 대시보드 관리자 앱을 통한 crud 작업 관리 이 인터페이스 내에서 다음을 수행할 수 있습니다 기록 추가하기 새 항목을 만들기 위해 모든 컬렉션(예 항목) 내에서 “기록 추가” 옵션을 클릭하세요 기록 보기 및 편집하기 기록을 선택하여 필드를 검사하거나 수정하세요 기록 제거하기 삭제 기능을 사용하여 오래된 기록을 제거하세요 이 간소화된 도구는 데이터 관리 작업을 단순화하여 사용자 경험을 향상시킵니다 4단계 – stenciljs와 back4app 연결하기 백엔드가 관리자 앱을 통해 구성되고 관리되면, 다음 단계는 stenciljs 프론트엔드를 back4app에 연결하는 것입니다 옵션 a rest 또는 graphql api 사용하기 stenciljs의 경우, 간단하게 api 통합에 집중하겠습니다 예시 rest를 통한 데이터 가져오기 // example rest api call to retrieve items const fetchitems = async () => { try { const response = await fetch('https //parseapi back4app com/classes/items', { headers { 'x parse application id' 'your application id', 'x parse rest api key' 'your rest api key' } }); const data = await response json(); console log('items retrieved ', data results); } catch (error) { console error('error retrieving items ', error); } }; fetchitems(); 필요에 따라 이러한 api 호출을 stenciljs 구성 요소에 통합하세요 옵션 b parse sdk 활용 (원하는 경우) parse sdk를 사용하고 싶다면, javascript 라이브러리이기 때문에 stenciljs 프로젝트 내에서 여전히 통합할 수 있습니다 그러나 여기서의 예제는 api 호출에 중점을 두고 있습니다 5단계 – 백엔드 강화하기 액세스 제어 목록(acl) 구현하기 객체에 acl을 설정하여 데이터 보안을 보장하세요 예를 들어, 개인 항목을 생성하려면 async function createsecureitem(itemdata, owneruser) { const items = parse object extend('items'); const item = new items(); item set('title', itemdata title); item set('description', itemdata description); // define acl restrict read/write access to the owner const acl = new parse acl(owneruser); acl setpublicreadaccess(false); acl setpublicwriteaccess(false); item setacl(acl); try { const saveditem = await item save(); console log('secure item created ', saveditem); } catch (error) { console error('error creating item ', error); } } 클래스 수준 권한(clps) 구성하기 back4app 대시보드 내에서 각 컬렉션에 대해 clp를 설정하여 권한이 있는 사용자만 민감한 데이터에 접근할 수 있도록 하세요 6단계 – 사용자 인증 관리하기 사용자 계정 설정하기 back4app은 인증 관리를 위해 parse의 사용자 클래스를 사용합니다 stenciljs 프로젝트에서 사용자 등록 및 로그인을 다음과 같이 구현하세요 // example component for user signup import { component, h, state } from '@stencil/core'; import parse from ' /parseconfig'; @component({ tag 'app auth', styleurl 'app auth css', shadow true, }) export class appauth { @state() username string = ''; @state() password string = ''; @state() email string = ''; async handlesignup(event event) { event preventdefault(); const user = new parse user(); user set('username', this username); user set('password', this password); user set('email', this email); try { await user signup(); alert('user registered successfully!'); } catch (error) { alert('registration error ' + error message); } } render() { return ( \<form onsubmit={(e) => this handlesignup(e)}> \<input type="text" placeholder="username" value={this username} oninput={(e any) => this username = e target value} /> \<input type="password" placeholder="password" value={this password} oninput={(e any) => this password = e target value} /> \<input type="email" placeholder="email" value={this email} oninput={(e any) => this email = e target value} /> \<button type="submit">register\</button> \</form> ); } } 로그인 및 세션 관리에 유사한 구조를 적용할 수 있습니다 또한 back4app 대시보드에서 소셜 로그인, 이메일 확인 및 비밀번호 재설정과 같은 기능을 직접 활성화할 수 있습니다 7단계 – 웹 배포를 통한 stenciljs 프론트엔드 시작하기 back4app의 웹 배포 기능을 사용하면 github 리포지토리에서 코드를 직접 배포하여 stenciljs 애플리케이션을 호스팅할 수 있습니다 7 1 프로덕션 번들 빌드하기 터미널에서 프로젝트 디렉토리를 엽니다 빌드 명령을 실행합니다 npm run build 이 명령은 최적화된 정적 자산을 포함하는 www 폴더를 생성합니다 빌드 확인 www 폴더에 필요한 css, js 및 이미지 파일과 함께 index html 이 포함되어 있는지 확인합니다 7 2 소스 코드 정리 및 업로드 귀하의 저장소는 stenciljs 애플리케이션의 모든 소스 파일을 포함해야 합니다 예시 구조는 다음과 같을 수 있습니다 basic crud app stenciljs frontend/ ├── node modules/ ├── www/ │ └── index html ├── src/ │ ├── components/ │ │ ├── app auth tsx │ │ └── app items tsx │ ├── global/ │ └── parseconfig ts ├── stencil config ts ├── package json └── readme md 예시 소스 파일 src/parseconfig ts // src/parseconfig ts import parse from 'parse'; // insert your back4app credentials here parse initialize('your application id', 'your javascript key'); parse serverurl = 'https //parseapi back4app com'; export default parse; 예시 소스 파일 src/components/app items tsx import { component, h, state } from '@stencil/core'; import parse from ' /parseconfig'; @component({ tag 'app items', styleurl 'app items css', shadow true, }) export class appitems { @state() items any\[] = \[]; @state() newtitle string = ''; @state() newdescription string = ''; @state() editingid string | null = null; @state() editingtitle string = ''; @state() editingdescription string = ''; async componentwillload() { await this loaditems(); } async loaditems() { const items = parse object extend("items"); const query = new parse query(items); try { const results = await query find(); this items = results; } catch (error) { console error('error fetching items ', error); } } async additem() { const items = parse object extend("items"); const item = new items(); item set("title", this newtitle); item set("description", this newdescription); try { await item save(); this newtitle = ''; this newdescription = ''; this loaditems(); } catch (error) { console error('error adding item ', error); } } async deleteitem(id string) { try { const item = await parse object createwithoutdata("items", id); await item destroy(); this loaditems(); } catch (error) { console error('error deleting item ', error); } } startedit(item any) { this editingid = item id; this editingtitle = item get("title"); this editingdescription = item get("description"); } async updateitem() { try { const items = parse object extend("items"); const item = new items(); item id = this editingid!; item set("title", this editingtitle); item set("description", this editingdescription); await item save(); this editingid = null; this editingtitle = ''; this editingdescription = ''; this loaditems(); } catch (error) { console error('error updating item ', error); } } render() { return ( \<div style={{ padding '2rem' }}> \<h1>items\</h1> \<div> \<h2>add new item\</h2> \<input type="text" placeholder="title" value={this newtitle} oninput={(e any) => this newtitle = e target value} /> \<input type="text" placeholder="description" value={this newdescription} oninput={(e any) => this newdescription = e target value} /> \<button onclick={() => this additem()}>add item\</button> \</div> \<ul> {this items map(item => \<li key={item id}> {this editingid === item id ? ( \<div> \<input type="text" value={this editingtitle} oninput={(e any) => this editingtitle = e target value} /> \<input type="text" value={this editingdescription} oninput={(e any) => this editingdescription = e target value} /> \<button onclick={() => this updateitem()}>save\</button> \<button onclick={() => this editingid = null}>cancel\</button> \</div> ) ( \<div> \<strong>{item get("title")}\</strong> {item get("description")} \<button onclick={() => this startedit(item)}>edit\</button> \<button onclick={() => this deleteitem(item id)}>delete\</button> \</div> )} \</li> )} \</ul> \</div> ); } } 코드를 github에 커밋하기 git 저장소 초기화 프로젝트 디렉토리에서 (아직 하지 않았다면) git init 파일 스테이징 git add 변경 사항 커밋 git commit m "stenciljs 프론트엔드 코드의 초기 커밋" 새 github 저장소 만들기 이름을 다음과 같이 지정하세요 basic crud app stenciljs frontend 코드를 github에 푸시하기 git remote add origin https //github com/your username/basic crud app stenciljs frontend git git push u origin main 7 3 웹 배포를 통한 리포지토리 연결 웹 배포 접근 back4app 대시보드에 로그인하고, 프로젝트 ( basic crud app stenciljs )를 선택한 후 웹 배포 섹션을 클릭하세요 github 통합 제공된 지침에 따라 github 계정을 연결하세요 이렇게 하면 back4app이 귀하의 리포지토리에 접근할 수 있습니다 리포지토리 및 브랜치 선택 리포지토리 (예 basic crud app stenciljs frontend )를 선택하고 적절한 브랜치 (예 main )를 선택하세요 7 4 배포 설정하기 추가 배포 세부정보를 입력하세요 빌드 명령어 저장소에 미리 빌드된 www 폴더가 포함되어 있지 않으면 빌드 명령어를 지정하세요 (예 npm run build ) back4app은 배포 중에 이를 실행합니다 출력 디렉토리 출력 디렉토리를 www 로 설정하여 back4app이 정적 파일을 찾을 수 있도록 하세요 환경 변수 배포 설정에 필요한 환경 변수를 추가하세요 (예 api 키) 7 5 docker로 stenciljs 프로젝트 컨테이너화하기 배포를 위해 docker를 선호하는 경우, 다음과 유사한 dockerfile 을 저장소에 포함하세요 \# use an official node image to build the app from node 16 alpine as build \# set working directory workdir /app \# copy dependency files copy package json / \# install dependencies run npm install \# copy source code copy \# build the app run npm run build \# use nginx to serve the app from nginx\ stable alpine copy from=build /app/www /usr/share/nginx/html expose 80 cmd \["nginx", " g", "daemon off;"] 이 파일을 저장소에 포함하고 back4app에서 docker 배포를 선택하세요 7 6 애플리케이션 배포 배포 시작 설정을 구성한 후 배포 버튼을 클릭하세요 빌드 프로세스 보기 back4app이 github에서 코드를 가져오고, 빌드 명령(설정된 경우)을 실행하며, 컨테이너화된 애플리케이션을 배포합니다 애플리케이션 접근 배포가 완료되면 back4app이 stenciljs 앱이 라이브인 url을 제공합니다 7 7 배포 검증 url 방문 제공된 url을 웹 브라우저에서 엽니다 기능 테스트 애플리케이션이 제대로 로드되고, 라우트가 올바르게 작동하며, 모든 자산(css, js, 이미지)이 문제 없이 제공되는지 확인합니다 필요시 디버깅 브라우저 개발자 도구를 사용하여 오류를 검사합니다 문제가 발생하면 back4app 로그를 확인하고 github 및 빌드 구성을 검증합니다 8단계 – 요약 및 향후 방향 잘 하셨습니다! stenciljs와 back4app을 사용하여 완전한 crud 애플리케이션을 성공적으로 구축했습니다 " basic crud app stenciljs "라는 제목의 프로젝트를 설정하고, 항목 및 사용자에 대한 컬렉션을 설계하며, 관리 앱을 통해 데이터를 관리했습니다 또한, stenciljs 프론트엔드를 백엔드에 연결하고 강력한 보안 조치를 구현했습니다 다음 단계 프론트엔드 개선 상세 항목 보기, 검색 기능 및 실시간 알림과 같은 고급 기능으로 stenciljs 앱을 확장하는 것을 고려하세요 기능 추가 복잡한 백엔드 로직(예 클라우드 함수), 서드파티 api 통합 또는 역할 기반 권한을 구현하세요 지식 심화 성능 조정 및 사용자 정의 통합에 대한 추가 통찰력을 위해 back4app 문서 https //www back4app com/docs 및 기타 튜토리얼을 탐색하세요 이 튜토리얼을 따라 하면서, 강력한 애플리케이션을 만드는 데 필요한 기술을 습득했습니다