IT4Change/boilerplate-backend
3
0
Fork 0
mirror of https://github.com/IT4Change/boilerplate-backend.git synced 2025-12-13 10:25:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

vuepress & cleanup readme

Browse Source
This commit is contained in:
Ulf Gebhardt 2023-12-07 17:24:41 +01:00
parent 48c89df8ac
commit 813e560251
Signed by: ulfgebhardt
GPG Key ID: DA6B843E748679C9
4 changed files with 2302 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.vuepress/config.ts Normal file
View File

@ -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'],
})

15
README.md
View File

@ -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** | |
| `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 |
| **Documentation** | |
| `npm run docs:dev` | Run Documentation in development mode |
| `npm run docs:build` | Build static documentation |
### 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/

2275
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

13
package.json
View File

@ -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",
"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"
"docs:dev": "vuepress dev .",
"docs:build": "vuepress build .",
"update": "npx npm-check-update"
},
"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/*",