Skip to content

README_KR.md

Latest commit

 

History

History
111 lines (66 loc) · 3.36 KB

README_KR.md

File metadata and controls

111 lines (66 loc) · 3.36 KB

React Mdi Portal

브라우저 내 개인화된 위젯을 생성해보세요.

시연영상

Feature

프로젝트는 React, Nest로 구성되어 있으며, 다음과 같은 기능을 지원합니다.

  • 🌐 브라우저 위젯 생성
  • 🕒 시계 위젯 생성
  • 🖱️ 위젯 Drag&Drop
  • ↔️ 위젯 Resize
  • 📏 위젯 Grid Sort
  • 🗂️ 위젯 Stack Sort
  • 👁️ 위젯 숨기기
  • 🔲 위젯 최대화
  • 👁️‍🗨️ 모든 위젯 숨기기
  • 📂 모든 위젯 오픈
  • 💾 위젯 상태 저장

데모

다음 데모 링크를 통해 배포된 프로젝트를 사용해볼 수 있습니다

  • 프론트엔드: Vercel에 호스팅
  • 백엔드: Koyeb에 호스팅

브라우저에서 개인화된 위젯 생성 및 관리 기능을 직접 체험해보세요!

  • react mdi portal

    이 링크를 통해 react mdi portal의 모든 기능을 체험해볼 수 있습니다.

Quick start

본인의 커스텀 앱을 넣고싶다면 Custom 를 참고해주세요, 또한 본인만의 스타일을 입히고 싶다면 Style 가이드를 참고해주세요

요구사항

  • Node.js (최소 14.0.0 버전 이상 권장)
  • npm

1. 레포지토리 클론

git clone https://github.com/moonklabs/react-mdi-portal.git

2. 프론트엔드 실행

터미널을 생성해 아래 명령어를 입력해주세요. VSCode를 사용중이시라면 상단에 터미널을 클릭 후 새 터미널을 통해 만들 수 있습니다.

cd frontend

frontend 폴더로 접근합니다.

npm install

의존성 설치

npm run start

로컬 실행

2. Backend -->

백엔드 환경을 실행시키기 위해 새로운 터미널을 생성해주세요.

cd backend

backend 폴더로 접근합니다.

npm install

의존성 설치

npm run start

로컬 실행

이 프로젝트는 기본적으로 SQLite를 사용하고 있습니다. MySQL, PostgreSQL 을 적용하고 싶으시다면 해당 링크를 참고해주세요 데이터베이스 설정 가이드

Contributing

  • 추가하고 싶은 기능이 있거나 버그를 발견하셨다면 메일로 보내주세요.

About

저와 개발일지가 궁금하시다면 About, 개발일지 를 클릭해주시고 이 프로젝트가 도움이 되셨다면 star 버튼으로 표현해주세요!