{"id":21029858,"url":"https://github.com/kitconcept/kitconcept.intranet","last_synced_at":"2026-01-16T16:35:27.972Z","repository":{"id":199027342,"uuid":"701805741","full_name":"kitconcept/kitconcept.intranet","owner":"kitconcept","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-09T19:12:00.000Z","size":61016,"stargazers_count":3,"open_issues_count":16,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-11T12:11:33.308Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kitconcept.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2023-10-07T15:59:14.000Z","updated_at":"2025-05-08T07:34:21.000Z","dependencies_parsed_at":"2025-02-27T18:41:00.940Z","dependency_job_id":"057eef7f-4206-450a-8625-0cffea8d0699","html_url":"https://github.com/kitconcept/kitconcept.intranet","commit_stats":null,"previous_names":["kitconcept/kitconcept.intranet"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fkitconcept.intranet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fkitconcept.intranet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fkitconcept.intranet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fkitconcept.intranet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kitconcept","download_url":"https://codeload.github.com/kitconcept/kitconcept.intranet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253561695,"owners_count":21927792,"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":[],"created_at":"2024-11-19T12:14:43.167Z","updated_at":"2026-01-16T16:35:27.953Z","avatar_url":"https://github.com/kitconcept.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kitconcept Intranet 🚀\n\n[![Built with Cookieplone](https://img.shields.io/badge/built%20with-Cookieplone-0083be.svg?logo=cookiecutter)](https://github.com/plone/cookiecutter-plone/)\n[![Tests](https://github.com/kitconcept/kitconcept.intranet/actions/workflows/main.yml/badge.svg)](https://github.com/kitconcept/kitconcept.intranet/actions/workflows/main.yml)\n\nA Plone distribution for Intranets with Plone. Created by kitconcept.\n\n## Quick Start 🏁\n\n### Prerequisites\n\n- Docker (https://www.docker.com/)\n- Git (https://git-scm.com/downloads)\n\n### Set up local demo instance\n\n- Clone repository with `git clone https://github.com/kitconcept/kitconcept.intranet.git`\n- Change directory to \"kitconcept.intranet\" with `cd kitconcept.intranet`\n- Start Docker containers with `docker-compose up`\n- Open kitconcept.intranet in your browser by typing `http://kitconcept-intranet.localhost/` into your browser URL field\n\n## Development\n\n### Prerequisites ✅\n\nEnsure you have the following installed:\n\n- Python 3.12 🐍\n- Node 22 🟩\n- pnpm 🧶\n- Docker 🐳\n- UV (See [https://docs.astral.sh/uv/getting-started/installation/#standalone-installer])\n\n### Installation 🔧\n\n1. Clone the repository:\n\n```shell\ngit clone git@github.com:kitconcept/kitconcept.intranet.git\ncd kitconcept.intranet\n```\n\n2. Install both Backend and Frontend:\n\n```shell\nmake install\n```\n\n### Fire Up the Servers 🔥\n\n1. Create a new Plone site on your first run:\n\n```shell\nmake backend-create-site\n```\n\nor create the site manually by visiting [http://localhost:8080/](http://localhost:8080/).\n\n2. Start the Backend at [http://localhost:8080/](http://localhost:8080/):\n\n```shell\nmake backend-start\n```\n\n3. In a new terminal, start the Frontend at [http://localhost:3000/](http://localhost:3000/):\n\n```shell\nmake frontend-start\n```\n\nVoila! Your Plone site should be live and kicking! 🎉\n\n### Manual site creation 🔥\n\nPoint your browser at [http://localhost:8080/](http://localhost:8080/) and you will be greated with the site creation page:\n\n\u003cimg alt=\"first step\" src=\"./docs/docs/_static/01-new-site.png\" width=\"640\" /\u003e\n\nAfter selecting **kitconcept Intranet** you will see a form:\n\n\u003cimg alt=\"first step\" src=\"./docs/docs/_static/02-auth-internal.png\" width=\"640\" /\u003e\n\n### Amend Example Content\n\nFirst, make sure that you do not have the backend process running.\n\nDelete existing site and all its content and re-create a new Plone site:\n\n````\nmake backend-delete-and-create-site\n````\n\nStart the backend with:\n\n````\nmake backend-start\n````\n\nand amend the content on the site.\n\nStop the backend by killing the `make backend-start` process (CTRL+C).\n\nExport the content of the Plone site to your local repository (make sure the backend is stopped for this):\n\n````\nmake backend-update-example-content\n````\n\nShow the diff in your local repository:\n\n````\ngit diff\n````\n\nCommit your changes:\n\n````\ngit add .\ngit checkout -b \u003cMY_BRANCH\u003e\ngit commit . -m\"\u003cMY_COMMIT_MESSAGE\u003e\"\ngit push\n````\n\nGo to [github.com/kitconcept/kitconcept.intranet](https://github.com/kitconcept/kitconcept.intranet/pulls) and click on the banner that shows your PR. Click on \"Compare \u0026 pull request\".\n\n#### Authentication\n\nChoosing **Keycloak** for user authentication will present configuration options:\n\n\u003cimg alt=\"first step\" src=\"./docs/docs/_static/03-auth-keycloak.png\" width=\"300\" /\u003e\n\n\nChoosing **OIDC / OAuth2** for user authentication will present configuration options:\n\n\u003cimg alt=\"first step\" src=\"./docs/docs/_static/04-auth-oidc.png\" width=\"300\" /\u003e\n\n\nChoosing **Google** for user authentication will present configuration options:\n\n\u003cimg alt=\"first step\" src=\"./docs/docs/_static/05-auth-google.png\" width=\"300\" /\u003e\n\n\nChoosing **GitHub** for user authentication will present configuration options:\n\n\u003cimg alt=\"first step\" src=\"./docs/docs/_static/06-auth-github.png\" width=\"300\" /\u003e\n\n\n### Local Stack Deployment 📦\n\nDeploy a local `Docker Compose` environment that includes:\n\n- Docker images for Backend and Frontend 🖼️\n- A stack with a Traefik router and a Postgres database 🗃️\n- Accessible at [http://kitconcept.intranet.localhost](http://kitconcept.intranet.localhost) 🌐\n\nExecute the following:\n\n```shell\nmake stack-start\nmake stack-create-site\n```\n\nAnd... you're all set! Your Plone site is up and running locally! 🚀\n\n## Project Structure 🏗️\n\nThis monorepo consists of three distinct sections: `backend`, `frontend`, and `devops`.\n\n- **backend**: Houses the API and Plone installation, utilizing pip instead of buildout, and includes a policy package named kitconcept.intranet.\n- **frontend**: Contains the React (Volto) package.\n- **devops**: Encompasses Docker Stack, Ansible playbooks, and Cache settings.\n\n### Why This Structure? 🤔\n\n- All necessary codebases to run the site are contained within the repo (excluding existing addons for Plone and React).\n- Specific GitHub Workflows are triggered based on changes in each codebase (refer to .github/workflows).\n- Simplifies the creation of Docker images for each codebase.\n- Demonstrates Plone installation/setup without buildout.\n\n## Code Quality Assurance 🧐\n\nTo automatically format your code and ensure it adheres to quality standards, execute:\n\n```shell\nmake check\n```\n\nLinters can be run individually within the `backend` or `frontend` folders.\n\n## Internationalization 🌐\n\nGenerate translation files for Plone and Volto with ease:\n\n```shell\nmake i18n\n```\n\n## Credits and Acknowledgements 🙏\n\nCrafted with care by **Generated using [Cookieplone (0.7.0)](https://github.com/plone/cookieplone) and [cookiecutter-plone (9937161)](https://github.com/plone/cookiecutter-plone/commit/993716123f0616eea9074ae4bd82eb3fcd48c4f1) on 2024-05-28 19:04:49.900739**. A special thanks to all contributors and supporters!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fkitconcept.intranet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitconcept%2Fkitconcept.intranet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fkitconcept.intranet/lists"}