{"id":18111617,"url":"https://github.com/bedita/bedita","last_synced_at":"2025-04-04T22:06:56.961Z","repository":{"id":4229486,"uuid":"5352389","full_name":"bedita/bedita","owner":"bedita","description":"BEdita, ready to use back-end API, extensible API-first Content Management","archived":false,"fork":false,"pushed_at":"2025-03-28T14:40:23.000Z","size":46961,"stargazers_count":67,"open_issues_count":18,"forks_count":21,"subscribers_count":13,"default_branch":"5-salix","last_synced_at":"2025-03-28T15:32:41.504Z","etag":null,"topics":["api-first","api-server","backend","bedita","cakephp","mysql","php","php7","php8","postgres","restful-api"],"latest_commit_sha":null,"homepage":"https://www.bedita.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bedita.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-08-09T07:13:29.000Z","updated_at":"2025-03-25T11:57:13.000Z","dependencies_parsed_at":"2023-09-28T17:28:39.989Z","dependency_job_id":"0eef72a3-d1a3-4401-a262-bdf6a55b988b","html_url":"https://github.com/bedita/bedita","commit_stats":{"total_commits":4184,"total_committers":21,"mean_commits":"199.23809523809524","dds":0.5544933078393881,"last_synced_commit":"ecc5f66c64d13a47972effe6df55b43257403785"},"previous_names":[],"tags_count":177,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bedita%2Fbedita","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bedita%2Fbedita/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bedita%2Fbedita/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bedita%2Fbedita/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bedita","download_url":"https://codeload.github.com/bedita/bedita/tar.gz/refs/heads/5-salix","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247256112,"owners_count":20909240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-first","api-server","backend","bedita","cakephp","mysql","php","php7","php8","postgres","restful-api"],"created_at":"2024-11-01T01:06:53.032Z","updated_at":"2025-04-04T22:06:56.941Z","avatar_url":"https://github.com/bedita.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BEdita, a back-end API\n\n[![Build Status](https://github.com/bedita/bedita/workflows/Run%20tests/badge.svg)](https://github.com/bedita/bedita/actions?query=workflow%3A%22Run+tests%22)\n[![Publish plugins](https://github.com/bedita/bedita/workflows/Publish%20components/badge.svg)](https://github.com/bedita/bedita/actions?query=workflow%3A%22Publish+components%22)\n[![Code Coverage](https://codecov.io/gh/bedita/bedita/branch/5-salix/graph/badge.svg)](https://codecov.io/gh/bedita/bedita/branch/5-salix)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bedita/bedita/badges/quality-score.png?b=5-salix)](https://scrutinizer-ci.com/g/bedita/bedita/?branch=5-salix)\n\nBEdita 5 is a ready to use back-end API to handle the data of your mobile, IoT, web and desktop applications.\nIt's also an extensible framework to build your custom back-end API via plugins.\n\nIt provides a complete content management solution with:\n\n* a _headless_ HTTP server application with a complete REST API to model, create, modify and retrieve data\n* a default admin web application **[BEdita Manager](https://github.com/bedita/manager)**\n\nBEdita 5 is built with [CakePHP 4](http://cakephp.org) and uses relational DBMS like [MySQL](http://www.mysql.com),\n[Postgres](https://www.postgresql.org) or [SQLite](http://sqlite.com) in conjunction with (optional) NoSQL systems like [Redis](http://redis.io/), [Elastic Search](https://www.elastic.co/) or time series databases to boost performance and scale up to Big Data scenarios.\n\n[JSON-API](http://jsonapi.org) is the primary exchange data format.\n\n[GrapQL](http://graphql.org) initial support available via dedicated plugin.\n\nThe easiest and quickest way to try out BEdita4 is via [Docker](https://www.docker.com), [read instructions below](#docker).\n\n## Prerequisites\n\n* PHP 7.4, 8.0, 8.1, 8.2 or 8.3 with extensions: `json`, `mbstring`, `fileinfo`, `intl`, `pdo`, `simplexml`\n* MySQL 8.0 (recommended) or MySQL 5.7, Postgres 11/12/13/14, MariaDB 10.2/10.3/10.4 or SQLite 3\n* [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)\n\n## Install\n\nFor a detailed setup overview see [Setup Documentation](https://docs.bedita.net/en/latest/setup.html)\n\nQuick setup in three steps.\n\n01. Create project via composer\n\n ```bash\n  composer create-project bedita/bedita\n ```\n\n If you are using a **.zip** or **.tar.gz** release file you just need to unpack it and then run ``composer install``.\n\n02. Create an empty database either MySQL or PostgresSQL. Do nothing for SQLite.\n\n03. Change to the newly created folder and run this script to initialize the database and create first admin user:\n\n```bash\n bin/cake bedita setup\n```\n\nSee [Web Server setup](https://docs.bedita.net/en/latest/setup.html#web-server)\nto configure a virtualhost in your webserver.\nTo see first [`/home` endpoint](https://docs.bedita.net/en/latest/endpoints/home.html) response you may point to `http://your-vhost/home`\n\nCurl example:\n\n```bash\n curl -H Accept:application/json http://your-vhost/home\n```\n\nOtherwise, only for development or test setups, you can take advantage of PHP builtin server with this simple command:\n\n```bash\n bin/cake server\n```\n\nand see `/home` endpoint response pointing to `http://localhost:8765/home` like this:\n\n```bash\n curl -H Accept:application/json http://localhost:8765/home\n```\n\nFor an explanation on `Accept` headers usage [read here](https://docs.bedita.net/en/latest/endpoints/intro.html#headers).\n\n## Docker\n\nSee [Docker setup documentation](https://docs.bedita.net/en/latest/setup.html#setup-docker) for a more detailed overview.\n\n### Pull official image\n\nGet latest offical image build from Docker Hub\n\n```bash\n docker pull bedita/bedita:latest\n```\n\nYou may also use `:5-salix` tag instead of `:latest`, they are currently synonyms.\n\n### Build image\n\nIf you want to build an image from local sources you can do it like this from BEdita root folder:\n\n```bash\n docker build -t bedita5-local .\n```\n\nYou may of course choose whatever name you like for the generated image instead of `bedita5-local`.\n\n### Run\n\nRun a Docker image setting an initial API KEY and admin username and password, like this:\n\n```bash\n docker run -p 8090:80 --env BEDITA_API_KEY=1029384756 \\\n    --env BEDITA_ADMIN_USR=admin --env BEDITA_ADMIN_PWD=admin \\\n    bedita/bedita:latest\n```\n\nThis will launch a BEdita4 instance using `SQLite` as its storage backend. It should become available at http://localhost:8090/home almost instantly.\n\nReplace `bedita/bedita:latest` with `bedita5-local` (or other chosen name) to lanch a local built image.\n\n## Documentation\n\nDeveloper documentation can be found [here](https://docs.bedita.net)\n\n## Licensing\n\nBEdita is released under [LGPL](/bedita/bedita/blob/master/LICENSE.LGPL), Lesser General Public License v3.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbedita%2Fbedita","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbedita%2Fbedita","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbedita%2Fbedita/lists"}