diff --git a/.env.dist b/.env.dist index 5dbe5cc0..a8286692 100644 --- a/.env.dist +++ b/.env.dist @@ -55,7 +55,7 @@ REDIS_HOST=redis REDIS_PORT=6379 REDIS_AUTH=redis_pass -MAILER_EMAIL=info@cmp.io +MAILER_EMAIL=info@example.com MAILER_FROM="Consent Management Platform" SENTRY_DSN=https://hash@sentry.io/123 diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index d662eaa7..00000000 --- a/LICENSE.md +++ /dev/null @@ -1,21 +0,0 @@ -# MIT License - -Copyright (c) 2022 '68 Publishers - -> Permission is hereby granted, free of charge, to any person obtaining a copy -> of this software and associated documentation files (the "Software"), to deal -> in the Software without restriction, including without limitation the rights -> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -> copies of the Software, and to permit persons to whom the Software is -> furnished to do so, subject to the following conditions: -> -> The above copyright notice and this permission notice shall be included in all -> copies or substantial portions of the Software. -> -> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -> SOFTWARE. diff --git a/README.md b/README.md index 5052b663..0abec673 100644 --- a/README.md +++ b/README.md @@ -14,19 +14,17 @@ * [Installation](#installation) * [Product Documentation](#product-documentation) * [Development Guide](#development-guide) -* [License](#license) ## About CMP -The CMP is a standalone application for logging cookie consent and managing the cookies themselves on any website. -You can implement the integration with the application in the cookie bar on your website, however, if you use [our solution](https://github.com/68publishers/cookie-consent), the integration is ready for you. +The CMP is a standalone application for storing users' cookie consent and managing the cookies themselves on any website or application. ![CMP Application](docs/images/dashboard.png) ## Getting Started ### Prerequisites -- Docker Compose +- Docker - Make ### Installation @@ -48,7 +46,3 @@ For documentation of the application from a user perspective, please go to the [ ## Development Guide For more technical information, please go to the [Development Guide](docs/development.md). - -## License - -The package is distributed under the MIT License. See [LICENSE](LICENSE.md) for more information. diff --git a/docs/development.md b/docs/development.md index ccf96e94..3bfe30bf 100644 --- a/docs/development.md +++ b/docs/development.md @@ -128,14 +128,12 @@ If the debug mode is enabled (`APP_DEBUG=1` or the user has set the `APP_DEBUG_C ## API and integration -The application exposes out API to communicate with the cookie bar. +The application exposes our API to communicate with the cookie widget. All endpoints are described using OpenApi. To display the Swagger UI, set the ENV variable `API_DOCS_ENABLED` to `1` and open the `http://localhost:8888/api/docs` page in your browser. If you use [68publishers/cookie-consent](https://github.com/68publishers/cookie-consent) on your sites, there is no need to manually integrate or call anything, everything is already prepared, and you just need to set the GTM tag correctly. -You can read how to integrate it in the 68publishers/cookie-consent documentation. - -@TODO documentation link +You can read how to integrate it in the 68publishers/cookie-consent [documentation](https://github.com/68publishers/cookie-consent#integration-with-cmp-application). ## How to update to the latest version diff --git a/docs/images/cookie-bar-page.png b/docs/images/cookie-widget-page.png similarity index 100% rename from docs/images/cookie-bar-page.png rename to docs/images/cookie-widget-page.png diff --git a/docs/product.md b/docs/product.md index ca349803..72b8ba6d 100644 --- a/docs/product.md +++ b/docs/product.md @@ -16,7 +16,7 @@ * [Imports](#imports) * [Projects](#projects) * [Consents](#consents) - * [Cookies bars](#cookie-bars) + * [Cookie widgets](#cookie-widgets) * [Project cookies](#project-cookies) * [Integration](#integration) @@ -80,8 +80,8 @@ The application provides only two roles - `admin` and `manager` with following p | Create a project | | :white_check_mark: | | `Project > Consents` | Manager | Admin | | View the list of consents | :white_check_mark: | :white_check_mark: | -| `Project > Cookie bars` | Manager | Admin | -| View the list of cookie bars | :white_check_mark: | :white_check_mark: | +| `Project > Cookie widgets` | Manager | Admin | +| View the list of cookie widgets | :white_check_mark: | :white_check_mark: | | `Project > Cookies > Providers` | Manager | Admin | | View and edit project providers | :white_check_mark: | :white_check_mark: | | `Project > Cookies > Project cookies` | Manager | Admin | @@ -229,21 +229,21 @@ So the correct procedure is to establish your projects first and then import the ## Projects -After selecting a specific project, the user is moved to the context of the selected project where he can see consents, cookie bar settings and manage project cookies. +After selecting a specific project, the user is moved to the context of the selected project where he can see consents, cookie widget settings and manage project cookies. ### Consents Here is the list of all recorded consents. -The consents are grouped according to the user identifier that the cookie bar creates and sends. After clicking on a detail, you can see the complete history of that user. +The consents are grouped according to the user identifier that the cookie widget creates and sends. After clicking on a detail, you can see the complete history of that user. Consents page -### Cookie bars +### Cookie widgets -On this page you can find the settings of all cookie bars used. -The uniqueness of the cookie bar is determined by the checksum that is calculated and sent by the cookie bar itself. +On this page you can find the settings of all cookie widgets used. +The uniqueness of the cookie widget is determined by the checksum that is calculated and sent by the cookie widget itself. -Cookie bars page +Cookie widgets page ### Project cookies diff --git a/translations/App_Web_AdminModule_ProjectModule_Control_ConsentHistory_ConsentHistoryControl.en.neon b/translations/App_Web_AdminModule_ProjectModule_Control_ConsentHistory_ConsentHistoryControl.en.neon index 7429eef7..8c19d7ff 100644 --- a/translations/App_Web_AdminModule_ProjectModule_Control_ConsentHistory_ConsentHistoryControl.en.neon +++ b/translations/App_Web_AdminModule_ProjectModule_Control_ConsentHistory_ConsentHistoryControl.en.neon @@ -6,4 +6,4 @@ App_Domain_Consent_Event_ConsentCreated: consents: Consents attributes: Attributes -settings_checksum: Bar settings +settings_checksum: Widget settings diff --git a/translations/App_Web_AdminModule_ProjectModule_Control_ConsentList_ConsentListControl.en.neon b/translations/App_Web_AdminModule_ProjectModule_Control_ConsentList_ConsentListControl.en.neon index d18e0468..832aea50 100644 --- a/translations/App_Web_AdminModule_ProjectModule_Control_ConsentList_ConsentListControl.en.neon +++ b/translations/App_Web_AdminModule_ProjectModule_Control_ConsentList_ConsentListControl.en.neon @@ -1,4 +1,4 @@ user_identifier: User identifier -settings_checksum: Bar settings +settings_checksum: Widget settings created_at: Created last_update_at: Updated diff --git a/translations/App_Web_AdminModule_ProjectModule_Control_ConsentSettingsDetail_ConsentSettingsDetailModalControl.en.neon b/translations/App_Web_AdminModule_ProjectModule_Control_ConsentSettingsDetail_ConsentSettingsDetailModalControl.en.neon index f53ca989..9b4c4d89 100644 --- a/translations/App_Web_AdminModule_ProjectModule_Control_ConsentSettingsDetail_ConsentSettingsDetailModalControl.en.neon +++ b/translations/App_Web_AdminModule_ProjectModule_Control_ConsentSettingsDetail_ConsentSettingsDetailModalControl.en.neon @@ -1,5 +1,5 @@ title: ''' -Cookie bar +Cookie widget %checksum% version %shortIdentifier% ''' diff --git a/translations/App_Web_AdminModule_ProjectModule_Presenter_ConsentSettingsPresenter.en.neon b/translations/App_Web_AdminModule_ProjectModule_Presenter_ConsentSettingsPresenter.en.neon index a59daa38..889648ab 100644 --- a/translations/App_Web_AdminModule_ProjectModule_Presenter_ConsentSettingsPresenter.en.neon +++ b/translations/App_Web_AdminModule_ProjectModule_Presenter_ConsentSettingsPresenter.en.neon @@ -1 +1 @@ -page_title: Cookie bars +page_title: Cookie widgets diff --git a/translations/layout.en.neon b/translations/layout.en.neon index 16ed1b3c..f5adaefb 100644 --- a/translations/layout.en.neon +++ b/translations/layout.en.neon @@ -17,7 +17,7 @@ sidebar: sidebar_project: consents: Consents - consent_settings: Cookie bars + consent_settings: Cookie widgets cookies: Cookies cookies_providers: Providers cookies_cookies: Project cookies