bedita / manager
BEdita Manager - official admin webapp for BEdita4 API
Installs: 543
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 8
Forks: 11
Open Issues: 6
Type:project
Requires
- php: >=7.4
- bedita/i18n: ^4.4.3
- bedita/web-tools: ^4.0.2
- cakephp/authentication: ^2.9
- cakephp/cakephp: ~4.5.0
- cakephp/plugin-installer: ^1.3
- josegonzalez/dotenv: ^3.2
- league/flysystem: ^2.5
- league/oauth2-github: ^3.0
- league/oauth2-google: ^4.0
- mobiledetect/mobiledetectlib: ^2.8
- phpoffice/phpspreadsheet: ^1.22
- thenetworg/oauth2-azure: ^2.2
- wikimedia/composer-merge-plugin: ^2.0.1
Requires (Dev)
- cakephp/bake: ^2.6
- cakephp/cakephp-codesniffer: ~4.7.0
- cakephp/console: ^4.4
- cakephp/debug_kit: ^4.7.1
- cakephp/repl: ^0.1
- dereuromark/cakephp-ide-helper: ~1.17.0
- phpstan/extension-installer: ^1.2
- phpstan/phpstan: ^1.8.2
- phpstan/phpstan-deprecation-rules: ^1.0
- phpunit/phpunit: ^9.5
- vimeo/psalm: ^5.18
- dev-master
- v4.35.4
- v4.35.3
- v4.35.2
- v4.35.1
- v4.35.0
- v4.34.1
- v4.34.0
- v4.33.4
- v4.33.3
- v4.33.2
- v4.33.1
- v4.33.0
- v4.32.4
- v4.32.3
- v4.32.2
- v4.32.1
- v4.32.0
- v4.31.1
- v4.31.0
- v4.30.1
- v4.30.0
- v4.29.4
- v4.29.3
- v4.29.2
- v4.29.1
- v4.29.0
- v4.28.2
- v4.28.1
- v4.28.0
- v4.27.1
- v4.27.0
- v4.26.1
- v4.26.0
- v4.25.3
- v4.25.2
- v4.25.1
- v4.25.0
- v4.24.4
- v4.24.3
- v4.24.2
- v4.24.1
- v4.24.0
- v4.23.1
- v4.23.0
- v4.22.2
- v4.22.1
- v4.22.0
- v4.21.12
- v4.21.11
- v4.21.10
- v4.21.9
- v4.21.8
- v4.21.7
- v4.21.6
- v4.21.5
- v4.21.4
- v4.21.3
- v4.21.2
- v4.21.1
- v4.21.0
- v4.20.1
- v4.20.0
- v4.19.2
- v4.19.1
- v4.19.0
- v4.18.1
- v4.18.0
- v4.17.7
- v4.17.6
- v4.17.5
- v4.17.4
- v4.17.3
- v4.17.2
- v4.17.1
- v4.17.0
- v4.16.2
- v4.16.1
- v4.16.0
- v4.15.9
- v4.15.8
- v4.15.7
- v4.15.6
- v4.15.5
- v4.15.4
- v4.15.3
- v4.15.2
- v4.15.1
- v4.15.0
- v4.14.5
- v4.14.4
- v4.14.3
- v4.14.2
- v4.14.1
- v4.14.0
- v4.13.6
- v4.13.5
- v4.13.4
- v4.13.3
- v4.13.2
- v4.13.1
- v4.13.0
- v4.12.7
- v4.12.6
- v4.12.5
- v4.12.4
- v4.12.3
- v4.12.2
- v4.12.1
- v4.12.0
- v4.11.3
- v4.11.2
- v4.11.1
- v4.11.0
- v4.10.15
- v4.10.14
- v4.10.13
- v4.10.12
- v4.10.11
- v4.10.10
- v4.10.9
- v4.10.8
- v4.10.7
- v4.10.6
- v4.10.5
- v4.10.4
- v4.10.3
- v4.10.2
- v4.10.1
- v4.10.0
- v4.9.6
- v4.9.5
- v4.9.4
- v4.9.3
- v4.9.2
- v4.9.1
- v4.9.0
- v4.8.5
- v4.8.4
- v4.8.3
- v4.8.2
- v4.8.1
- v4.8.0
- v4.7.4
- v4.7.3
- v4.7.2
- v4.7.1
- v4.7.0
- v4.6.9
- v4.6.8
- v4.6.7
- v4.6.6
- v4.6.5
- v4.6.4
- v4.6.3
- v4.6.2
- v4.6.1
- v4.6.0
- v4.5.10
- v4.5.9
- v4.5.8
- v4.5.7
- v4.5.6
- v4.5.5
- v4.5.4
- v4.5.3
- v4.5.2
- v4.5.1
- v4.5.0
- v4.4.4
- v4.4.3
- v4.4.2
- v4.4.1
- v4.4.0
- v4.3.7
- v4.3.6
- v4.3.5
- v4.3.4
- v4.3.3
- v4.3.2
- v4.3.1
- v4.3.0
- v4.2.3
- v4.2.2
- v4.2.1
- v4.2.0
- v4.1.8
- v4.1.7
- v4.1.6
- v4.1.5
- v4.1.4
- v4.1.3
- v4.1.2
- v4.1.1
- v4.1.0
- v4.0.12
- v4.0.11
- v4.0.10
- v4.0.9
- v4.0.8
- v4.0.7
- v4.0.6
- v4.0.5
- v4.0.4
- v4.0.3
- v4.0.2
- v4.0.1
- v4.0.0
- 3.x-dev
- v3.5.1
- v3.5.0
- v3.4.8
- v3.4.7
- v3.4.6
- v3.4.5
- v3.4.4
- v3.4.3
- v3.4.2
- v3.4.1
- v3.4.0
- v3.3.16
- v3.3.15
- v3.3.14
- v3.3.13
- v3.3.12
- v3.3.11
- v3.3.10
- v3.3.9
- v3.3.8
- v3.3.7
- v3.3.6
- v3.3.5
- v3.3.4
- v3.3.3
- v3.3.2
- v3.3.1
- v3.3.0
- v3.2.1
- v3.2.0
- v3.1.8
- v3.1.7
- 3.1.6
- v3.1.5
- v3.1.4
- v3.1.3
- v3.1.2
- v3.1.1
- v3.1.0
- v3.0.0
- 2.x-dev
- v2.2.1
- v2.2.0
- v2.1.0
- v2.0.0
- v1.2.0
- v1.1.0
- v1.0.0
- dev-dependabot/npm_and_yarn/tinymce-7.0.0
This package is auto-updated.
Last update: 2024-09-26 12:13:23 UTC
README
Backend Manager for BEdita API.
Prerequisites
Install
- Create project via
composer
composer create-project bedita/manager
This will create a new manager
folder and install composer dependencies.
If you are using a .zip or .tar.gz release file you just need to unpack it and then run composer install
. Run same command if you do a git clone
on this repo.
- Build JS/CSS bundles with
yarn
frommanager
folder
yarn && yarn build
- Configure BEdita API base URL and API KEY in
config/.env
like:
# set BEDITA base URL export BEDITA_API="{bedita-url}" # set BEDITA API KEY (optional) export BEDITA_API_KEY="{bedita-api-key}"
To test the webapp you can simply run builtin webserver from manager
folder like this
bin/cake server
And then point your browser to http://localhost:8765/
For any other use than a simple test we recommend to configure your preferred web server like Nginx/Apache and point to webroot/
as vhost document root.
## Configuration
You can further configure your BEdita Manager instance in config/app_local.php
with environment and project specific settings.
Have look at the main Manager configuration wiki page on how to customize your Manager instance.
Docker
Pull official image
Get latest offical image build from Docker Hub
docker pull bedita/manager:4
Build image
If you want to build an image from local sources you can do it like this from root folder:
docker build -t manager-local .
You may of course choose whatever name you like for the generated image instead of manager-local
.
Run
Run a Docker image setting API base url and API KEY like this:
docker run -p 8080:80 \ --env BEDITA_API={bedita-api-url} --env BEDITA_API_KEY={bedita-api-key} \ bedita/manager:latest
Replace bedita/manager:latest
with manager-local
(or other chosen name) to lanch a local built image.
JS Development with webpack
Using .env
It's easy to configure config/.env
to match your web server and proxy requirements, see below.
(default proxy: localhost:8080, default server: localhost:3000)
# BE Manager Entry Point WEBPACK_SERVER_HOST=localhost WEBPACK_SERVER_PORT=3000 # Proxy server WEBPACK_PROXY_HOST=local-be4-web WEBPACK_PROXY_PORT=8080
To start develop mode run
yarn develop
Production build with Bundle Report
yarn run bundle-report
ESlint
- Run ESlint via
yarn
, to check linting on js files
yarn run eslint resources/js/app/pages/admin/index.js
Run unit tests
To setup tests locally simply copy tests/.env.example
to tests/.env
and set env vars accordingly.
To launch tests:
vendors/bin/phpunit [test folder or file, default '/tests']
To run those tests you may want to use a Docker image as BEdita4 API endpoint.
For instance if you can pull a Docker image via docker pull bedita/bedita:4
or docker pull bedita/bedita:5
Then you may run the image with
docker run -p 8090:80 --env BEDITA_ADMIN_USR=bedita --env BEDITA_ADMIN_PWD=bedita bedita/bedita:5
You can then set env vars accordingly like this:
export BEDITA_API="http://localhost:8090" export BEDITA_ADMIN_USR="bedita" export BEDITA_ADMIN_PWD="bedita"
and you're ready to go
Licensing
BEdita is released under LGPL, Lesser General Public License v3.