diff --git a/.env.example b/.env.example index 818e517b..10e1df88 100644 --- a/.env.example +++ b/.env.example @@ -1,4 +1,16 @@ SCHEME=http HOSTNAME=localhost:3000 RATELIMIT_WINDOWTIME=900000 -RATELIMIT_WINDOWSIZE=10 \ No newline at end of file +RATELIMIT_WINDOWSIZE=10 + +# Analytics Configuration: +# ======================== +# +# Analytics Provider Name +ANALYTICS_ENABLED=false +ANALYTICS_PROVIDER=ConsoleProvider +# Configuration for the Plausible Analytics Engine +PLAUSIBLE_CONFIGURATION={"baseUrl":"","loggingURL": "
" +# Configuration for the Console Logging. +CONSOLELOG_CONFIGURATION={"logEmoji":"πŸ”"} + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea78..801ec7f1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -13,9 +13,9 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: 1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Click on '....' +1. Scroll down to '....' +1. See error **Expected behavior** A clear and concise description of what you expected to happen. @@ -24,15 +24,15 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] **Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] **Additional context** Add any other context about the problem here. diff --git a/.gitignore b/.gitignore index 76c0b4b1..4b8c3942 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,10 @@ npm-debug.log .DS_Store .idea coverage -.vscode \ No newline at end of file +.vscode + +# ignoring mapped volumes for docker compose / plausible +plausible-conf.env +db-data +event-data +clickhouse \ No newline at end of file diff --git a/.remarkrc b/.remarkrc new file mode 100644 index 00000000..add0cd9f --- /dev/null +++ b/.remarkrc @@ -0,0 +1,20 @@ +{ + "settings": { + "incrementListMarker": false + }, + "plugins": [ + "preset-lint-consistent", + "preset-lint-recommended", + "lint-heading-increment", + ["lint-no-undefined-references",false], + [ + "lint-list-item-indent","space" + ], + [ + "lint-unordered-list-marker-style", "consistent" + ], + [ + "lint-ordered-list-marker-value", "one" + ] + ] +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7f1a683..ca313aa4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,4 @@ + # Contributing to Mocked-API @@ -14,15 +15,15 @@ All types of contributions are encouraged and valued. See the [Table of Contents ## Table of Contents - - [I Have a Question](#i-have-a-question) - - [I Want To Contribute](#i-want-to-contribute) - - [Reporting Bugs](#reporting-bugs) - - [Suggesting Enhancements](#suggesting-enhancements) - - [Your First Code Contribution](#your-first-code-contribution) - - [Improving The Documentation](#improving-the-documentation) - - [Coding Conventions](#Coding-Conventions) - - [Commit Messages](#commit-messages) - - [Join The Project Team](#join-the-project-team) +- [I Have a Question](#i-have-a-question) +- [I Want To Contribute](#i-want-to-contribute) +- [Reporting Bugs](#reporting-bugs) +- [Suggesting Enhancements](#suggesting-enhancements) +- [Your First Code Contribution](#your-first-code-contribution) +- [Improving The Documentation](#improving-the-documentation) +- [Coding Conventions](#coding-conventions) +- [Commit Messages](#commit-messages) +- [Join The Project Team](#join-the-project-team) @@ -130,8 +131,8 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/agedde include Setup of env, IDE and typical getting started instructions? --> 1. When adding new API endpoints, please add OpenAPI comments -2. All code must have corresponding unit tests. -3. All API endpoints must have unit tests for all return codes. +1. All code must have corresponding unit tests. +1. All API endpoints must have unit tests for all return codes. ### Improving The Documentation