Skip to content

Latest commit

 

History

History
72 lines (39 loc) · 1.94 KB

README.md

File metadata and controls

72 lines (39 loc) · 1.94 KB

Orbit

Orbit은 Slack Reminder에서 영감을 받아 탄생하였습니다.

orbit은 space marketplace app으로 space에 예약메시지 기능을 추가하는 project 입니다.

예약 메세지 등록은 2가지 타입을 제공합니다.

  • cron expression
    • 등록 예시는 여기를 참고해주세요
  • weekly
    • 특정 요일시간에 예약 메세지를 발송합니다.

필수 등록 정보는 아래와 같습니다.

  • channelName : 메세지를 보낼 채널의 이름 (기존 채널에만 예약 메세지 전송 예약 가능)
  • timezone: 메세지를 전송할 시각에 대한 timezone 정보
  • message: 예약 메세지의 content
  • type (cron 또는 weekly)
    • date, time (type이 weekly일 경우)
    • cron (type이 cron일 경우)

등록 예시

  • cron

    • Screenshot 2024-04-28 at 3.56.09 PM
  • weekly

    • Screenshot 2024-04-28 at 3.58.04 PM

프로젝트 설명

tech stack

stackticon

prerequisites

  • node.js 18.17
  • yarn

config

실행을 위해서 .env 설정이 필요합니다.
자세한 값들은 프로젝트 문서를 확인해주시기 바랍니다. (문서)

cp .env.template .env

getting started

yarn install
yarn dev