fix: update Apache Casbin link
3 files changed
tree: 3cfb48d9cf683232a37d49f67f8adadc7c308790
  1. .github/
  2. app/
  3. messages/
  4. public/
  5. test/
  6. .asf.yaml
  7. .editorconfig
  8. .eslintrc.json
  9. .gitignore
  10. .prettierrc.json
  11. components.json
  12. jest.config.js
  13. LICENSE
  14. main.js
  15. middleware.ts
  16. netlify.toml
  17. next.config.mjs
  18. package.json
  19. postcss.config.js
  20. preload.js
  21. README.md
  22. tailwind.config.ts
  23. tsconfig.json
  24. yarn.lock
README.md

Casbin-editor

semantic-release Build and Deploy Build Release GitHub issues GitHub forks Sourcegraph License Discord

Casbin-editor is a web-based Casbin model and policy editor. It's based on Next.js + TypeScript.

Use the Casbin-editor to write your Casbin model and policy in your web browser. It provides functionality such as syntax highlighting and code completion, just like an IDE for a programming language.

Try it at either:

  1. Apache Casbin Editor (official ASF deployment): https://casbin-editor.apache.org/
  2. Apache Casbin website: https://casbin.apache.org/editor

How it works?

Casbin-editor is a pure frontend Javascript project. It uses node-casbin to perform policy enforcement. It's notable that node-casbin can be used either in frontend Javascript or Node.js.

This project can be viewed as an example for using node-casbin in the browser.

Website deployment (ASF)

The public site is not published with GitHub Pages anymore. CI builds the static Next.js output and pushes it to the repository’s asf-site branch; Apache Infrastructure then serves it at https://casbin-editor.apache.org/.

  • Workflow: .github/workflows/master.yml (Build and Deploy)
  • Triggers: push to master, workflow_dispatch, and pull requests (PRs only run build; they do not publish)
  • Build: yarn install and yarn build (static export to the out/ directory)
  • ASF metadata: root .asf.yaml is copied to out/.asf.yaml before publish so the published tree includes the file Infra expects
  • Publish: peaceiris/actions-gh-pages with publish_branch: asf-site, publish_dir: ./out, and force_orphan: true (each deploy replaces the branch history for a clean site-only tree)

Repository settings for GitHub Pages (if any) are unrelated to this flow; the live editor URL is the ASF domain above.

For Dev

yarn install
yarn dev

Open browser: http://localhost:3000/

Production Preview

yarn build

# Make sure port 3000 is not in use
yarn start

Open browser: http://localhost:3000/

For Electron

This project supports being built as an Electron app:

yarn install
yarn dist

If the packaged app cannot load the local out/ bundle, it falls back to loading https://casbin-editor.apache.org/ in the window.