{"id":38917557,"url":"https://github.com/kitconcept/volto-contact-block","last_synced_at":"2026-01-17T15:29:09.570Z","repository":{"id":322283903,"uuid":"1088634010","full_name":"kitconcept/volto-contact-block","owner":"kitconcept","description":null,"archived":false,"fork":false,"pushed_at":"2025-12-22T13:56:02.000Z","size":5484,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-24T00:50:20.029Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-03T08:45:18.000Z","updated_at":"2025-12-12T10:45:00.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/kitconcept/volto-contact-block","commit_stats":null,"previous_names":["kitconcept/volto-contact-block"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kitconcept/volto-contact-block","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-contact-block","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-contact-block/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-contact-block/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-contact-block/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kitconcept","download_url":"https://codeload.github.com/kitconcept/volto-contact-block/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitconcept%2Fvolto-contact-block/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28511480,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T13:38:16.342Z","status":"ssl_error","status_checked_at":"2026-01-17T13:37:44.060Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-01-17T15:29:09.441Z","updated_at":"2026-01-17T15:29:09.534Z","avatar_url":"https://github.com/kitconcept.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# volto contact block 🚀\n\n[![Built with Cookieplone](https://img.shields.io/badge/built%20with-Cookieplone-0083be.svg?logo=cookiecutter)](https://github.com/plone/cookieplone-templates/)\n[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![CI](https://github.com/kitconcept/volto-contact-block/actions/workflows/main.yml/badge.svg)](https://github.com/kitconcept/volto-contact-block/actions/workflows/main.yml)\n\nContact block by kitconcept\n\n## Quick Start 🏁\n\n### Prerequisites ✅\n\n-   An [operating system](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation) that runs all the requirements mentioned.\n-   [uv](https://6.docs.plone.org/install/create-project-cookieplone.html#uv)\n-   [nvm](https://6.docs.plone.org/install/create-project-cookieplone.html#nvm)\n-   [Node.js and pnpm](https://6.docs.plone.org/install/create-project.html#node-js) 24\n-   [Make](https://6.docs.plone.org/install/create-project-cookieplone.html#make)\n-   [Git](https://6.docs.plone.org/install/create-project-cookieplone.html#git)\n-   [Docker](https://docs.docker.com/get-started/get-docker/) (optional)\n\n\n### Installation 🔧\n\n1.  Clone this repository, then change your working directory.\n\n    ```shell\n    git clone git@github.com:kitconcept/volto-contact-block.git\n    cd volto-contact-block\n    ```\n\n2.  Install this code base.\n\n    ```shell\n    make install\n    ```\n\n\n### Fire Up the Servers 🔥\n\n1.  Create a new Plone site on your first run.\n\n    ```shell\n    make backend-create-site\n    ```\n\n2.  Start the backend at http://localhost:8080/.\n\n    ```shell\n    make backend-start\n    ```\n\n3.  In a new shell session, start the frontend at http://localhost:3000/.\n\n    ```shell\n    make frontend-start\n    ```\n\nVoila! Your Plone site should be live and kicking! 🎉\n\n### Local Stack Deployment 📦\n\nDeploy a local Docker Compose environment that includes the following.\n\n- Docker images for Backend and Frontend 🖼️\n- A stack with a Traefik router and a PostgreSQL database 🗃️\n- Accessible at [http://volto-contact-block.localhost](http://volto-contact-block.localhost) 🌐\n\nRun the following commands in a shell session.\n\n```shell\nmake stack-create-site\nmake stack-start\n```\n\nAnd... you're all set! Your Plone site is up and running locally! 🚀\n\n## Project structure 🏗️\n\nThis monorepo consists of the following distinct sections:\n\n- **backend**: Houses the API and Plone installation, utilizing pip instead of buildout, and includes a policy package named kitconcept.contactblock.\n- **frontend**: Contains the React (Volto) package.\n- **devops**: Encompasses Docker stack, Ansible playbooks, and cache settings.\n- **docs**: Scaffold for writing documentation for your project.\n\n### Why this structure? 🤔\n\n- All necessary codebases to run the site are contained within the repository (excluding existing add-ons 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 check your code against quality standards, run the following shell command.\n\n```shell\nmake check\n```\n\n### Format the codebase\n\nTo format and rewrite the code base, ensuring it adheres to quality standards, run the following shell command.\n\n```shell\nmake format\n```\n\n| Section | Tool | Description | Configuration |\n| --- | --- | --- | --- |\n| backend | Ruff | Python code formatting, imports sorting  | [`backend/pyproject.toml`](./backend/pyproject.toml) |\n| backend | `zpretty` | XML and ZCML formatting  | -- |\n| frontend | ESLint | Fixes most common frontend issues | [`frontend/.eslintrc.js`](.frontend/.eslintrc.js) |\n| frontend | prettier | Format JS and Typescript code  | [`frontend/.prettierrc`](.frontend/.prettierrc) |\n| frontend | Stylelint | Format Styles (css, less, sass)  | [`frontend/.stylelintrc`](.frontend/.stylelintrc) |\n\nFormatters can also be run within the `backend` or `frontend` folders.\n\n### Linting the codebase\nor `lint`:\n\n ```shell\nmake lint\n```\n\n| Section | Tool | Description | Configuration |\n| --- | --- | --- | --- |\n| backend | Ruff | Checks code formatting, imports sorting  | [`backend/pyproject.toml`](./backend/pyproject.toml) |\n| backend | Pyroma | Checks Python package metadata  | -- |\n| backend | check-python-versions | Checks Python version information  | -- |\n| backend | `zpretty` | Checks XML and ZCML formatting  | -- |\n| frontend | ESLint | Checks JS / Typescript lint | [`frontend/.eslintrc.js`](.frontend/.eslintrc.js) |\n| frontend | prettier | Check JS / Typescript formatting  | [`frontend/.prettierrc`](.frontend/.prettierrc) |\n| frontend | Stylelint | Check Styles (css, less, sass) formatting  | [`frontend/.stylelintrc`](.frontend/.stylelintrc) |\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\nGenerated using [Cookieplone (0.9.10)](https://github.com/plone/cookieplone) and [cookieplone-templates (96574af)](https://github.com/plone/cookieplone-templates/commit/96574af4136cae375cc74be36daed12df6ed6f82) on 2025-12-08 19:18:17.165395. A special thanks to all contributors and supporters!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fvolto-contact-block","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitconcept%2Fvolto-contact-block","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitconcept%2Fvolto-contact-block/lists"}