eces / select

🚀 Fast build tool for admin/backoffice by YAML declarative way.

Select Admin

Fast build tool for admin/backoffice by YAML declarative way.

운영 툴을 채우는 새로운 방법

어드민 페이지를 만들고 배포하고 관리하기에는 어렵고 SQL 쿼리와 API를 매번 만들면 시간이 계속 늘어납니다. 다른 방법은 없을까요?

최소 비용으로 빠른 기간내 팀 협업을 성공. 고객조회, 매출분석, 지표통계, 컨텐츠관리, 이력조회를 가입 후 3일 안에 해결하고 있습니다.

더 이상 DB, API 클라이언트에 의존하지 않아도 돼요.

설치형(로컬 실행 가능한) 오픈소스 업데이트를 준비중입니다! 조금만 기다려주세요.

Features

• mysql backend support. (production-ready)
• RESTful HTTP API backend support. (production-ready)
• pgsql backend support. (production-ready)
• mssql backend support. (production-ready)
• redis backend support.
• Google Spreadsheet backend support.
• MongoDB backend support. (production-ready)
• DynamoDB backend support.
• Firebase backend support.
• JavaScript request/response transformation support.
• User management.
• Permission and access control with roles.
• Customizable menus, groups and tabs.
• Mulitple pages with URL to share.
• Table UI
• Local sort, pagination
• Server-side pagination
• Query block type
• Modal(popup) block type
• Markdown block type
• Block-wide parameters
• Page-wide parameters
• Share and open saved search.
• Publishing API Endpoint
• SSH tunneling
• VPC Peering
• OIDC support

Usage

CLI

• npm install -g selectfromuser
• selectfromuser

Others

selectfromuser login selectfromuser whoami selectfromuser logout selectfromuser link selectfromuser unlink selectfromuser init selectfromuser dev

Docker container image

https://hub.docker.com/r/selectfromuser/admin https://github.com/eces/select/blob/main/docker-compose.yml

Documentation

ko-KR

• Documentation 개발자 문서
• Official Website 공식웹사이트
• UI Components 컴포넌트
• Changelog 업데이트 내역
• Blog 블로그
• Discourse 포럼
• Slack Community 슬랙 커뮤니티

Sample Recipe

index.yml

title: 셀렉트어드민

layout:
  style:
    backgroundColor: "#19234B !important"

menus:
- group: 회원
  name: 고객 관리
  path: users
  placement: menu-only
  redirect: users/active
  icon: mdi-account
  
  menus:
  - name: 결제 관리
    path: payments
    placement: menu-only
    icon: mdi-timeline-check

- group: 회원
  name: 최근가입자 목록
  path: users/active
  placement: tab-only

- group: 회원
  name: 휴면회원 목록
  path: users/dormant
  placement: tab-only

- group: 회원
  name: 마케팅 수신동의
  path: users/promotion
  placement: tab-only

- group: 기타메뉴
  name: 공식 문서 
  path: https://docs.selectfromuser.com
  target: _blank
  icon: mdi-book-open-variant
  iconEnd: 링크

- group: 기타메뉴
  name: 클라우드 이용
  path: https://app.selectfromuser.com
  target: _blank
  icon: mdi-tab
  iconEnd: 링크

# resources:
# - name: mysql.dev
#   mode: local
#   type: mysql
#   host: aaaa.ap-northeast-2.rds.amazonaws.com
#   port: 3306
#   username: user_aaaa
#   password: aaaa
#   database: aaaa
#   timezone: '+00:00'
#   extra:
#     charset: utf8mb4_general_ci

# pages:
# - path: healthcheck/db
#   blocks:
#   - type: query
#     resource: mysql.dev
#     sql: SELECT NOW()

users/index.yml

pages:
- path: users/active
  blocks: 
  - type: markdown
    content: >
      ## 7일 가입자 조회
    
- path: users/dormant
  blocks:
  - type: markdown
    content: >
      ## 휴면회원 조회
    
- path: users/promotion
  blocks:
  - type: markdown
    content: >
      ## 동의/미동의 조회

users/payment.yml

pages:
- path: payments
  title: 결제 및 환불
  blocks:
  - type: markdown
    content: |
      > 최근 7일 대상자 목록
  
  # - type: query
  #   name: Data from Query
  #   resource: mysql.dev
  #   sql: |
  #     SELECT * 
  #     FROM chat 
  #     ORDER BY id DESC
  #     LIMIT 3
  #   tableOptions:
  #     cell: true

  - type: http
    axios:
      method: GET
      url: https://api.selectfromuser.com/sample-api/users
    rowsPath: rows
    columns:
      name:
        label: Name
      age:
        label: Engagement Point

    showDownload: csv

    viewModal:
      useColumn: id
      # mode: side
      blocks:
      - type: http
        axios:
          method: GET
          url: https://api.selectfromuser.com/sample-api/users/{{user_id}}
        rowsPath: rows
        
        params:
        - key: user_id
          valueFromRow: id

        display: col-2
        title: "ID: {{id}}"
        showSubmitButton: false
        

        tabOptions:
          autoload: 1
          tabs:
          - name: 최근거래내역
            blocks: 
            - type: markdown
              content: 거래내역 내용
          - name: 프로모션참여
            blocks: 
            - type: markdown
              content: 프로모션 내용

Tests

npm test -- --grep="auth"

npm test -- --grep="block"

npm test -- --grep="config"

Support

해당 프로젝트는 2020년부터 2023년까지 Free/Pro/Team/Enterprise Plan 제공을 위해 Selectfromuser Inc. 개발팀 포함 커뮤니티가 계속 기능추가, 유지보수, 보안패치, 문서화를 하고 있습니다.

직접 설치하여 비용없이 무료이용 가능합니다. 그외에 정책은 라이센스를 따릅니다. 기능제안, 기술지원은 해당 페이지로 문의바랍니다. https://www.selectfromuser.com

select's Issues

Language support: english

• documentation
• text in sample recipe
• contact form

Roadmap

https://ysgteam.notion.site/BuildInPublic-b6c07b421fbd4592b87b0a5638c9ad40

New improvements and Fix bugs.

Added

• tabOptions
• showButtonWithResult
• http block methodType
• display: card
• display: col-1
• multiline field item
• chartOptions
• columnOptions.format = html (sanitized)
• columnOptions.format = json
• viewModal.width

Fixed

• Move excel download button
• Show text in button when value is empty for trigger modal open anyway.
• Pass correct option to astify to make compatible with pgsql.
• Fix datalist values bind

Google OAuth support

Using gsuite accounts identified by email instead of yml config[users].

• user by email config
• set up credentials, callback url
• hd: domain whitelist

Cloud CLI

https://blog.selectfromuser.com/editor-token-cli/

오픈소스 로드맵

2022년 9월 이후로 일시중단된 maintenance를 2023년 10월부터 다시 시작하고자 합니다.

방향성

• Block API 해당하는 서버만 프로젝트로 분리 (YAML to HTTP API)
• UI specification 논의하는 레파지토리 준비
• 로컬 환경 CLI로 모든 기능 이용할 수 있도록 준비 (23년 10월 기준: 구글시트, 모니터링 미지원)

참고할 케이스

• 해외 사용자도 Seoul 리전을 통해 접속하므로 불편함이 있는 상황. 새로운 리전 오픈 필요. (23년 10월 기준: 서울리전에 3개 zone이 있음)
• 문서가 영어가 아니라서 불편함

---

Direction

• Separating the server dedicated to the Block API into its own project (YAML to HTTP API).
• Should set up a repository for discussing UI specifications.
• Improve a local environment CLI so that all functions are ready to use (as of October 2023, Google Sheets and monitoring are not supported).

Reference cases

• Some users from abroad are facing inconvenience when accessing through the Seoul region. So, we might need to consider opening up a new region (as of October 2023, Seoul region has 3 zones).
• Some users find the documentation inconvenient due to it not written in English.

Move repo to organization.

Notice: temporarily discontinue to update in a short term.

Sadly,

Since v2 merge has been delayed for a long time,

There is no upcoming minor and major updates of v1 (current stable).

Why delayed?

The team who maintains this project is busy with working on serverless Select Admin; aka cloud hosted version.

How long until next?

With uncertainty, we are expecting that v2 merge will be continued by 2022.

Sorry for not giving announcement earlier. We'll be back soon.

Good news is still you can try cloud version (https://app.selectfromuser.com).

Thank you.

p.s.
Over 100+ users are using cloud version now. Generous free plan available.

LTS

• End-of-life v1: 2021.11~2022.09
• LTS v2: 2023.10~
  • Initial Release: 2023-10-09
  • Active LTS Start: -
  • Maintenance Start: 2024-03-05
  • End-of-life: 2025-10-31

Archive documentation

https://select-docs.vercel.app/