add remark linter, update README.md

.remarkrc.json

@@ -0,0 +1,16 @@
+{
+    "plugins": [
+        "remark-gfm",
+        "remark-preset-lint-consistent",
+        "remark-preset-lint-markdown-style-guide",
+        "remark-preset-lint-recommended",
+        [
+            "remark-lint-maximum-line-length",
+            false
+        ],
+        [
+            "remark-lint-list-item-indent",
+            "space"
+        ]
+    ]
+}

README.md

@@ -1,2 +1,48 @@
 # boilerplate-backend
-Boilerplate for an apollo express backend
+[![nodejs][badge-nodejs-img]][badge-nodejs-href]
+[![npm][badge-npm-img]][badge-npm-href]
+[![docker][badge-docker-img]][badge-docker-href]
+
+The IT4C Boilerplate for an apollo express backends.
+
+## Requirements & Technology
+
+To be able to build this project you need `nodejs`, `npm` and optional `docker`.
+
+The project sets up an apollo express server.
+
+## Commands
+
+The following commands are available:
+
+| Command                    | Description                              |
+|----------------------------|------------------------------------------|
+| **Develop**                |                                          |
+| `npm run dev`              | Compiles and hot-reloads for development |
+| **Test**                   |                                          |
+| `npm run test:lint`        | Run all linters                          |
+| `npm run test:lint:eslint` | Run linter eslint                        |
+| `npm run test:lint:remark` | Run linter remark                        |
+
+## Endpoints
+
+The following endpoints are provided given the right command is executed or all three if `docker compose` is used:
+
+| Endpoint                                                             | Description        |
+|----------------------------------------------------------------------|--------------------|
+| [http://localhost:4000/graphql](http://localhost:4000/graphql)       | GraphQL API        |
+| [http://localhost:4000/playground](http://localhost:4000/playground) | GraphQL Playground |
+
+## License
+
+[Apache 2.0](./LICENSE)
+
+<!-- Badges -->
+[badge-nodejs-img]: https://img.shields.io/badge/nodejs-%3E%3D20.5.0-blue
+[badge-nodejs-href]:  https://nodejs.org/
+
+[badge-npm-img]: https://img.shields.io/badge/npm-latest-blue
+[badge-npm-href]: https://www.npmjs.com/package/npm
+
+[badge-docker-img]: https://img.shields.io/badge/docker-latest-blue
+[badge-docker-href]: https://www.docker.com/

package.json

@@ -18,7 +18,9 @@
   "scripts": {
     "watch": "nodemon --watch './**/*.{ts,graphql}' --exec 'node --loader ts-node/esm' src/index.ts",
     "dev": "tsc-watch  --noClear --onSuccess \"npm run watch\"",
-    "test:lint:eslint": "eslint --ext .ts,.tsx,.js,.jsx,.json,.yml,.yaml --max-warnings 0 --ignore-path .gitignore ."
+    "test:lint": "npm run test:lint:eslint && npm run test:lint:remark",
+    "test:lint:eslint": "eslint --ext .ts,.tsx,.js,.jsx,.json,.yml,.yaml --max-warnings 0 --ignore-path .gitignore .",
+    "test:lint:remark": "remark . --quiet --frail"
   },
   "dependencies": {
     "apollo-server-express": "^3.13.0",
@@ -43,6 +45,11 @@
     "eslint-plugin-yml": "^1.10.0",
     "nodemon": "^3.0.1",
     "prettier": "^3.1.0",
+    "remark-cli": "^12.0.0",
+    "remark-gfm": "^4.0.0",
+    "remark-preset-lint-consistent": "^5.1.2",
+    "remark-preset-lint-markdown-style-guide": "^5.1.3",
+    "remark-preset-lint-recommended": "^6.1.3",
     "ts-node": "^10.9.1",
     "tsc": "^2.0.4",
     "tsc-watch": "^6.0.4",