프로젝트 소개
Attraccess는 메이커스페이스, 작업장, 시설과 같은 공유 환경을 위해 설계된 리소스 관리 시스템으로, 기계, 도구, 문에 대한 접근을 통제합니다. 리소스 상태, 사용량, 유지보수를 한 곳에서 추적하는 데 중점을 둡니다.
README에 설명된 핵심 기능:
- 리소스 관리: 리소스 상태, 사용량, 유지보수 이력을 추적합니다.
- 리소스 이미지 지원: 자동 크기 조정 및 캐싱을 포함합니다.
- 역할 기반 접근 제어: 누가 어떤 리소스를 사용할 수 있는지 결정합니다.
- 유지보수 일정: 유지보수 계획 및 기록을 지원합니다.
- 사용량 추적 및 보고: 리소스 사용 현황을 파악할 수 있게 합니다.
개발자 설정:
이 프로젝트는 Nx를 사용하는 Node.js/pnpm 모노레포입니다. 일반적인 API 및 프론트엔드 작업에는 Docker(메일핏, 오센틱, 키클로크 등 보조 서비스용), Node.js 20.10 이상(.nvmrc는 v24.13을 고정), pnpm 8 이상이 필요합니다. 설정 스크립트(scripts/setup-dev-dependencies.sh)는 필요 시 nvm을 통해 Node, pnpm, 프로젝트 의존성을 설치합니다. Docker는 수동으로 설치해야 합니다. Attractap 장치용 펌웨어 작업에는 추가로 프로젝트 로컬 ESP-IDF 툴체인이 필요하며, 설정 중 환경 플래그를 통해 활성화됩니다.
설치 단계는 저장소를 클론하고, pnpm install을 실행하고, .env.example을 .env로 복사하고, Nx 대상 api:migrations-run을 통해 데이터베이스 마이그레이션을 실행하는 것입니다.
개발 워크플로우:
pnpm serve를 실행하면 API와 프론트엔드가 개발 모드로 시작되며, 핫 모듈 교체와 자동 포트 해석이 지원됩니다. 런처는 사용 가능한 포트를 탐색하여 출력합니다. 기본값은 API 3000(3000-3099 검색), 프론트엔드 4200(4200-4299 검색), Vite 프리뷰 4300(4300-4399 검색)입니다. 개별 서비스는 --only=api 또는 --only=frontend로 시작할 수 있습니다. --tui를 통해 대화형 Nx 터미널 UI를 사용할 수 있으며, 기본 스트리밍 출력은 에이전트/CI 친화적이라고 설명됩니다. 포트는 PORT 및 VITE_PORT 환경 변수로 고정할 수 있으며, 프론트엔드 개발 프록시는 해석된 API 포트를 자동으로 대상으로 합니다. 해석된 포트는 저장소 루트의 gitignored .dev-serve-ports.json 파일에도 기록됩니다.
API 문서는 서버 실행 중 /api에서 Swagger로 제공됩니다.
라이선스 및 활성화:
Attraccess는 라이선스 검증을 포함하며 시작 시 LICENSE_KEY 환경 변수가 필요합니다. 키가 없으면 오류와 함께 즉시 종료됩니다. 상업 사용자는 구매 후 받은 키를 제공해야 합니다. 비영리 조직은 비영리 사용 및 라이선스 조건 준수를 명시하는 특정 제공 문자열로 LICENSE_KEY를 설정하여 소프트웨어를 무료로 사용할 수 있습니다. README는 셸 또는 로컬 .env 파일, Docker Compose, Docker CLI에서 이 변수를 설정하는 방법을 보여줍니다.
이 프로젝트는 수정된 Prosperity Public License v3.0에 따라 소스가 공개됩니다. 개인 및 비영리 조직은 사용, 수정, 재배포할 수 있습니다. 상업 사용자는 30일 평가판을 받습니다. 30일을 초과하는 상업적 사용은 상업 라이선스 없이 허용되지 않으며, 포크 또는 파생 프로젝트도 원저작자의 유효한 라이선스 없이 상업적 사용을 금지하는 동일한 조건이 적용됩니다. 일부 구성 요소는 MIT 라이선스 프로젝트에서 비롯되었으며 별도 라이선스 파일에 세부 정보가 포함된 MIT 라이선스로 제공됩니다. 상업 라이선스 문의는 contact@attraccess.org로 하십시오.
사용자 문서는 docs.attraccess.org에 별도로 호스팅되며, 기여 지침은 CONTRIBUTING.md에 제공됩니다. README는 Attractap 펌웨어 툴체인 외의 특정 하드웨어 통합을 설명하지 않으며, 지원되는 데이터베이스나 배포 토폴로지도 나열하지 않습니다.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.