Feature/docs

.env.dist

@@ -1,70 +1,42 @@
-########################################################################################################################
-# Environment Variables
-
-# APP_DEBUG=1
-# APP_DEBUG_COOKIE_SECRET=value
-
-# COOKIE_SECURE=1 # True for sending secure flag (https)
-# PROJECT_URL=https://www.example.com
-# PROJECT_INTERNAL_URL=https://www.example.com # Not required, the PROJECT_URL is used if this variable is not defined
-# PROJECT_API_URL=https://amp-api.example.com # Not required, the PROJECT_URL is used if this variable is not defined
-# TRUSTED_PROXIES=127.0.0.1 # Not required, IP or IPs separated by a comma. The range you can enter like 1.0.0.0/1
-# [email protected]
-# [email protected]
-# MAILER_FROM="Consent Management Platform"
-
-# RECAPTCHA_ENABLED=1
-# GOOGLE_RECAPTCHA_SITE_KEY=site-key
-# GOOGLE_RECAPTCHA_SECRET_KEY=secret-key
-
-# DB_HOST=server
-# DB_PORT=port
-# DB_NAME=dbname
-# DB_USER=user
-# DB_PASSWORD=password
-
-# REDIS_HOST=server
-# REDIS_PORT=port
-# REDIS_AUTH="" # optional
-# REDIS_DB_CACHE=0 # optional
-# REDIS_DB_SESSIONS=1 # optional
-
-# SMTP_ENABLED=1
-# SMTP_HOST=hostname
-# SMTP_PORT=port
-# SMTP_USERNAME=username
-# SMTP_PASSWORD=password
-# SMTP_SECURE=ssl # ssl or tls
-
-# SENTRY_DSN=https://[email protected]/project-id
-# GTM_CONTAINER_ID=GTM-XXXXXX # optional
-# API_DOCS_ENABLED=1 # optional
-# GRID_COUNT_LIMIT=100000 # optional
-########################################################################################################################
-
+# ========== Application environment ========== #
 APP_DEBUG=1
-APP_DEBUG_COOKIE_SECRET=idontgiveabuck07
-
-COOKIE_SECURE=0
+APP_DEBUG_COOKIE_SECRET=hey_tracy
 PROJECT_URL=http://localhost:8888
-PROJECT_INTERNAL_URL=http://localhost:8080
-[email protected]
-[email protected]
-MAILER_FROM="Consent Management Platform"
-
-RECAPTCHA_ENABLED=0
+# TRUSTED_PROXIES=127.0.0.1 # Not required, IP or IPs separated by a comma. The range you can enter like 1.0.0.0/1
+COOKIE_SECURE=0
+# COOKIE_SECURE=1 # For sending secure flag (https)
+API_DOCS_ENABLED=1
+GRID_COUNT_LIMIT=100000
+# GTM_CONTAINER_ID=GTM-XXXXXX # optional
 
+# ========== PostgreSQL database ========== #
 DB_HOST=db
 DB_PORT=5432
 DB_NAME=cmp
 DB_USER=root
 DB_PASSWORD=root
 
+# ========== Redis / KeyDB ========== #
 REDIS_HOST=redis
 REDIS_PORT=6379
 REDIS_AUTH=redis_pass
 REDIS_DB_CACHE=0
 REDIS_DB_SESSIONS=1
 
-SENTRY_DSN=https://[email protected]/123
-API_DOCS_ENABLED=1
+# ========== Emails & SMTP server ========== #
+[email protected]
+MAILER_FROM="Consent Management Platform"
+# SMTP_ENABLED=1
+# SMTP_HOST=hostname
+# SMTP_PORT=port
+# SMTP_USERNAME=username
+# SMTP_PASSWORD=password
+# SMTP_SECURE=ssl # ssl or tls
+
+# ========== Google reCAPTCHA ========== #
+RECAPTCHA_ENABLED=0
+# GOOGLE_RECAPTCHA_SITE_KEY=site-key
+# GOOGLE_RECAPTCHA_SECRET_KEY=secret-key
+
+# ===== Sentry logger ===== #
+#SENTRY_DSN=https://[email protected]/123

CHANGELOG.md

@@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Added optional ENV variables `REDIS_DB_CACHE` (default `0`) and `REDIS_DB_SESSIONS` (default `1`).
+- Added the `Development Guide` and `Product Documentation`.
+
+### Changed
+
+- Updated the README.
 
 ## 0.12.0 - 2023-02-27
 

Makefile

@@ -19,8 +19,9 @@ down:
 
 restart:
 	make stop
+	make stop-worker
 	make start
-	make data-migration
+	make start-worker
 
 cache:
 	docker exec -it cmp-app bin/console
@@ -95,6 +96,7 @@ init:
 	make start
 	make install
 	make data
+	make start-worker
 
 data:
 	make data-migration

README.md

@@ -1,6 +1,11 @@
-# Consent Management Platform
+<div align="center" style="text-align: center; margin-bottom: 50px">
+<img src="docs/images/logo.svg" alt="Consent Management Platform logo" align="center" width="150">
+<h1 align="center">Consent Management Platform</h1>
 
-> 🛡 Manage user consents and cookie widget with easy.
+🛡 Easily manage user consents and the cookie widget.
+</div>
+
+<br>
 
 ## Table of Contents
 * [About CMP](#about-cmp)
@@ -9,10 +14,12 @@
   * [Installation](#installation)
 * [Product Documentation](#product-documentation)
 * [Development Guide](#development-guide)
-* [Known Issues](#known-issues)
 
 ## About CMP
-...
+
+The CMP is a standalone application for storing user's cookie consents and managing the cookies themselves on any website or application.
+
+![CMP Application](docs/images/dashboard.png)
 
 ## Getting Started
 
@@ -22,30 +29,20 @@
 
 ### Installation
 ```sh
-$ git clone <repository-url> cmp
+$ git clone https://github.com/68publishers/consent-management-platform cmp
 $ cd cmp
 $ cp .env.dist .env
 $ make init
 ```
 
 Visit http://localhost:8888 and sign in via `[email protected]` / `admin` credentials.
 
-See [Makefile](./Makefile) for other usefull commands.
+See [Makefile](./Makefile) for other useful commands and the [Development Guide](docs/development.md) for information about ENV variables etc.
 
 ## Product Documentation
-...
 
-## Development Guide
-...
+For documentation of the application from a user perspective, please go to the [Product Documentation](docs/product.md).
 
-## Known issues
-When running application stack locally and get the following message:
-```sh
-An exception occurred in the driver:
-SQLSTATE[08006] [7] could not translate host name "cmp-db" to address: Name does not resolve
-```
+## Development Guide
 
-Simply restart the `db` service manualy:
-```sh
-$ docker compose restart db
-```
+For more technical information, please go to the [Development Guide](docs/development.md).

config/packages/contributte.monolog.neon

@@ -6,7 +6,7 @@ services:
         autowired: no
         type: Sentry\Client
         factory: Sentry\ClientBuilder::create([
-            dsn: ::env(SENTRY_DSN)
+            dsn: ::env(SENTRY_DSN, '')
             max_request_body_size: always
         ])::getClient()