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

update README.md for database

Browse Source
This commit is contained in:
Moriz Wahl 2023-12-07 11:12:54 +01:00
parent 91a0f26e2f
commit a1b8bae45a
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -6,6 +6,7 @@
[![apollo-server][badge-apollo-img]][badge-apollo-href] [![apollo-server][badge-apollo-img]][badge-apollo-href]
[![graphql][badge-graphql-img]][badge-graphql-href] [![graphql][badge-graphql-img]][badge-graphql-href]
[![type-graphql][badge-type-graphql-img]][badge-type-graphql-href] [![type-graphql][badge-type-graphql-img]][badge-type-graphql-href]
[![prisma][badge-prisma-img]][badge-prisma-href]
The IT4C Boilerplate for an apollo express backends. The IT4C Boilerplate for an apollo express backends.
@ -15,6 +16,10 @@ To be able to build this project you need `nodejs`, `npm` and optional `docker`.
The project sets up an apollo server. It uses `type-graphql`. The project sets up an apollo server. It uses `type-graphql`.
The project is set up for a `mysql` database, which is expected to
run. Copy the `.env.dist` file to `.env`. You can change the database
connection in the `prisma/schema.prisma` file and your local `.env`.
## Commands ## Commands
The following commands are available: The following commands are available:
@ -32,6 +37,10 @@ The following commands are available:
| `npm run test:lint:remark` | Run linter remark | | `npm run test:lint:remark` | Run linter remark |
| `npm run test:unit` | Run all unit tests and generate coverage report | | `npm run test:unit` | Run all unit tests and generate coverage report |
| `npm test` | Run all tests & linters | | `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 |
### Docker ### Docker
@ -90,3 +99,6 @@ The following endpoints are provided given the right command is executed or all
[badge-type-graphql-img]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FIT4Change%2Fboilerplate-backend%2Fmaster%2Fpackage.json&query=dependencies%5B%22type-graphql%22%5D&label=type-graphql&color=yellow [badge-type-graphql-img]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FIT4Change%2Fboilerplate-backend%2Fmaster%2Fpackage.json&query=dependencies%5B%22type-graphql%22%5D&label=type-graphql&color=yellow
[badge-type-graphql-href]: https://typegraphql.com/ [badge-type-graphql-href]: https://typegraphql.com/
[badge-graphql-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-graphql-href]: https://prisma.io/