만든 웹사이트를 웹 퍼블리셔로 바로 인터넷에 올리는 시작 저장소입니다.
명령 한 줄(npm run deploy)이면 https://<사이트이름>.sites.openiot.app 주소가 생깁니다.
서버, 데이터베이스, 보안, 트래픽 걱정 없이 화면만 만들면 됩니다.
- 웹 퍼블리셔에 가입하고 API 키 만들기를 누릅니다. 키는 그때 한 번만 보입니다.
- 아래 프롬프트에 키를 붙여 넣어 클로드 코드에게 줍니다. 기획 폴더에 만들고 싶은 서비스를 적어 두면 그대로 만들어 올립니다.
기획 폴더에 적어 둔 서비스 설명대로 웹사이트를 만들어서 인터넷에 올려 주세요.
1. 개발 폴더에 https://github.com/openiot-devteam/web-starter 를 받아서 시작합니다.
안내서(README)를 먼저 읽고 그대로 따릅니다.
2. 기획 폴더의 문서, 참고 링크, 디자인 캡처를 모두 읽고 화면을 만듭니다.
- 처음 온 사람도 바로 쓸 수 있고, 휴대폰에서도 잘 보이게 만들어 주세요.
- 글, 댓글, 신청서처럼 저장할 데이터는 스타터의 webdb 로 저장합니다. 서버는 따로 만들지 않습니다.
3. 개발 폴더의 .env 파일에 아래 한 줄을 넣습니다. 이 파일은 깃허브에 올리지 않습니다.
PUBLISHER_API_KEY=여기에_받은_키를_붙여넣기
4. publisher.json 의 site 를 서비스에 어울리는 영어 이름으로 바꾸고 npm run deploy 로 배포합니다.
5. 배포가 끝나면 주소를 알려 주세요. 오류가 나면 고쳐서 다시 배포합니다.
- Vite + React + TypeScript + Tailwind CSS 가 준비되어 있습니다.
src/App.tsx부터 바꿔 나갑니다. npm install다음npm run dev로 내 컴퓨터에서 미리 봅니다.- 정적 사이트만 됩니다. 서버 코드(Next.js SSR, API 라우트, Express 같은 것)는 돌지 않습니다. 화면에서 하는 일은 모두 브라우저에서 끝나야 합니다.
- 여러 화면이 필요하면 react-router 같은 화면 쪽 라우터를 씁니다.
publisher.json의spa가true라 어느 주소로 들어와도index.html이 열립니다. - 사진, 아이콘 같은 파일은
public/에 두고 주소로 씁니다.
글, 댓글, 신청서, 투표처럼 방문자가 남기는 데이터와 사진, 문서 같은 파일은 src/webdb.ts 로 저장합니다.
데이터는 웹 퍼블리셔 콘솔의 데이터베이스 칸에서 만든 DB에 들어갑니다. 코드만으로는 DB를 만들 수 없으므로,
DB가 필요하면 사용자에게 아래 1번을 콘솔에서 해 달라고 안내합니다.
-
콘솔의 데이터베이스 칸에서 (사용자가 합니다)
-
데이터가 필요하면 데이터 DB를 사이트 이름과 같은 이름으로 만들고, 그 안에 쓸 컬렉션을 만들며 방문자가 할 수 있는 일을 고릅니다.
고르는 것 누구나 할 수 있는 것 쓰임 방명록, 댓글 읽기, 쓰기 방명록, 댓글, 후기, 게시글 문의, 신청 폼 쓰기 (읽기는 주인만) 문의, 신청서, 설문. 받은 내용은 콘솔에서 봅니다 공지, 게시판 읽기 (쓰기는 주인만) 공지, 메뉴판, 일정 투표, 좋아요 카운터 읽기, 쓰기, 고치기 투표, 좋아요 수 직접 설정 동작마다 고름 위에 맞는 것이 없을 때 -
파일이 필요하면 파일 DB를
사이트이름-files로 만들고 규칙(갤러리, 받은 파일함, 게시판, 비공개)을 고릅니다. -
만든 DB의 연결된 사이트 탭에서 이 사이트를 연결합니다. 연결하지 않으면 화면에서 "DB를 찾을 수 없습니다" 오류가 납니다.
-
다른 이름으로 만들었다면
src/webdb.ts의DATA_DB,FILES_DB만 바꿉니다.
-
-
화면에서 이렇게 씁니다.
import { collection, files } from './webdb' const posts = collection<{ title: string; body: string }>('posts') await posts.add({ title: '첫 글', body: '안녕하세요' }) const items = await posts.all() // 최신순 const page = await posts.list({ limit: 20 }) // { items, nextCursor } const photo = await files.upload(input.files[0]) // { id, name, size, url } const all = await files.all() // 최신순 // <img src={files.url(photo.id)} />
- 문서 하나는 16KB, 컬렉션 하나에 1만 개까지입니다. 방문자 한 명이 분당 30번까지 쓰거나 올릴 수 있습니다.
- 파일은 하나 10MB, 파일 DB 하나 1GB까지. 이미지(jpg, png, gif, webp, avif, heic), pdf, txt, csv, docx, xlsx, pptx, hwp, hwpx, zip 만 받습니다.
- 누구나 읽을 수 있는 컬렉션이나 갤러리 파일 DB에는 전화번호, 이메일 같은 개인정보를 넣지 않습니다. 문의는 "문의, 신청 폼" 으로 받습니다.
- 내 컴퓨터(
npm run dev)에서도 데이터는 배포된 사이트 것을 씁니다. 그래서 한 번 배포한 뒤에 확인합니다.
.env.example을.env로 복사하고PUBLISHER_API_KEY에 사용자가 준 키를 넣습니다..env는 절대 깃허브에 올리지 않습니다.publisher.json의site를 서비스 이름으로 바꿉니다. 영어 소문자, 숫자, 하이픈으로 3~32자이고 이미 다른 사람이 쓰는 이름이면 다른 이름을 고릅니다.npm run deploy를 실행합니다. 빌드부터 업로드, 반영까지 한 번에 하고 마지막에 주소를 보여 줍니다.- 오류가 나면 메시지를 읽고 고쳐서 다시 배포합니다. 배포 기록과 되돌리기는 웹 퍼블리셔 대시보드의 내 사이트 칸에 있습니다.
파일 5,000개, 파일 하나 50MB, 합계 300MB. 한 사람당 사이트 10개, API 키 10개.
| 경로 | 무엇 |
|---|---|
src/App.tsx |
첫 화면 |
src/webdb.ts |
데이터 저장 도우미 |
publisher.json |
사이트 이름, 빌드 방법, 데이터 컬렉션 |
scripts/publish.mjs |
배포 스크립트 (설치할 것 없음, Node 18 이상) |
.env.example |
API 키 자리 |