Merge pull request #1 from IT4Change/docs

feat(docu): vuepress for docs

.gitignore

@@ -1,134 +1,10 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-.pnpm-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
 node_modules/
-jspm_packages/
+build/
-
+coverage/
-# Snowpack dependency directory (https://snowpack.dev/)
+!.vuepress/
-web_modules/
+.vuepress/.temp/
-
+.vuepress/.cache/
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional stylelint cache
-.stylelintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variable files
 .env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-build
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-.temp
-.cache
-
-# Docusaurus cache and generated files
-.docusaurus
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
 
 # emacs
 *~

.vuepress/config.ts

@@ -0,0 +1,9 @@
+import { defineUserConfig } from 'vuepress'
+
+export default defineUserConfig({
+  title: 'IT4C Backend Boilerplate Documentation',
+  description: 'IT4C Backend Boilerplate Documentation',
+  dest: 'build/docs',
+  base: process.env.VUEPRESS_BASE ? `/${process.env.VUEPRESS_BASE}/` : '/',
+  pagePatterns: ['**/*.md', '**/LICENSE', '!.vuepress', '!node_modules'],
+})

README.md

@@ -7,6 +7,7 @@
 [![graphql][badge-graphql-img]][badge-graphql-href]
 [![type-graphql][badge-type-graphql-img]][badge-type-graphql-href]
 [![prisma][badge-prisma-img]][badge-prisma-href]
+[![vuepress][badge-vuepress-img]][badge-vuepress-href]
 
 The IT4C Boilerplate for an apollo express backends.
 
@@ -31,16 +32,19 @@ The following commands are available:
 | `npm run start`            | Runs productions server                         |
 | **Develop**                |                                                 |
 | `npm run dev`              | Compiles and hot-reloads for development        |
+| **Database**               |                                                 |
+| `npm run db:migrate`       | Creates and executes migrations needed          |
+| `npm run db:reset`         | Drops Schema, run all migrations and seeds      |
+| `npm run db:seed`          | Run the seeds                                   |
 | **Test**                   |                                                 |
 | `npm run test:lint`        | Run all linters                                 |
 | `npm run test:lint:eslint` | Run linter eslint                               |
 | `npm run test:lint:remark` | Run linter remark                               |
 | `npm run test:unit`        | Run all unit tests and generate coverage report |
 | `npm test`                 | Run all tests & linters                         |
-| **Database**               |                                                 |
+| **Documentation**          |                                                 |
-| `npm run db:migrate`       | Creates and executes migrations needed          |
+| `npm run docs:dev`         | Run Documentation in development mode           |
-| `npm run db:reset`         | Drops Schema, run all migrations and seeds      |
+| `npm run docs:build`       | Build static documentation                      |
-| `npm run db:seed`          | Run the seeds                                   |
 
 ### Docker
 
@@ -102,3 +106,6 @@ The following endpoints are provided given the right command is executed or all
 
 [badge-prisma-img]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FIT4Change%2Fboilerplate-backend%2Fmaster%2Fpackage.json&query=dependencies.prisma&label=prisma&color=yellow
 [badge-prisma-href]: https://prisma.io/
+
+[badge-vuepress-img]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FIT4Change%2Fboilerplate-backend%2Fmaster%2Fpackage.json&query=devDependencies.vuepress&label=vuepress&color=orange
+[badge-vuepress-href]: https://vuepress.vuejs.org/

package.json

@@ -18,15 +18,17 @@
     "build": "tsc",
     "start": "npm run build && TZ=UTC TS_NODE_BASEURL=./build node -r tsconfig-paths/register build/src/index.js",
     "dev": "TZ=UTC nodemon -w src --ext ts,json --exec ts-node -r tsconfig-paths/register src/index.ts",
+    "db:migrate": "TZ=UTC npx prisma migrate dev",
+    "db:reset": "TZ=UTC npx prisma migrate reset --force",
+    "db:seed": "TZ=UTC npx prisma db seed",
     "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",
     "test:unit": "TZ=UTC jest --runInBand --forceExit --detectOpenHandles",
     "test": "npm run test:lint && npm run test:unit",
-    "update": "npx npm-check-update",
+    "docs:dev": "vuepress dev .",
-    "db:migrate": "TZ=UTC npx prisma migrate dev",
+    "docs:build": "vuepress build .",
-    "db:reset": "TZ=UTC npx prisma migrate reset --force",
+    "update": "npx npm-check-update"
-    "db:seed": "TZ=UTC npx prisma db seed"
   },
   "prisma": {
     "seed": "ts-node prisma/seed.ts"
@@ -69,7 +71,8 @@
     "ts-node": "^10.9.1",
     "tsc-watch": "^6.0.4",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.3.2"
+    "typescript": "^5.3.2",
+    "vuepress": "^2.0.0-rc.0"
   },
   "imports": {
     "#graphql/*": "./src/graphql/*",