{"id":13881022,"url":"https://github.com/microenv/graphql-prisma-boilerplate","last_synced_at":"2025-07-16T17:31:39.615Z","repository":{"id":41785382,"uuid":"251725237","full_name":"microenv/graphql-prisma-boilerplate","owner":"microenv","description":"🚀 Minimalist boilerplate for super fast Graphql ⭐Run Graphql Playground in your local environment in less than a minute (w/ docker-compose).","archived":false,"fork":false,"pushed_at":"2022-12-12T08:47:33.000Z","size":1253,"stargazers_count":3,"open_issues_count":12,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-24T10:34:27.707Z","etag":null,"topics":["boilerplate","docker-compose","graphql","nexus-future","prisma2","template"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microenv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-31T20:36:21.000Z","updated_at":"2020-12-23T20:10:01.000Z","dependencies_parsed_at":"2023-01-27T16:30:25.255Z","dependency_job_id":null,"html_url":"https://github.com/microenv/graphql-prisma-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/microenv/graphql-prisma-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microenv%2Fgraphql-prisma-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microenv%2Fgraphql-prisma-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microenv%2Fgraphql-prisma-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microenv%2Fgraphql-prisma-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microenv","download_url":"https://codeload.github.com/microenv/graphql-prisma-boilerplate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microenv%2Fgraphql-prisma-boilerplate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265527555,"owners_count":23782480,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boilerplate","docker-compose","graphql","nexus-future","prisma2","template"],"created_at":"2024-08-06T08:03:48.226Z","updated_at":"2025-07-16T17:31:37.628Z","avatar_url":"https://github.com/microenv.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Graphql Prisma2 Boilerplate\n\nA great boilerplate to start your new graphql project.\n\n## Development Setup\n\n```shell\nyarn install\nyarn local:db:up\n```\n\nWait until database is ready.\n\n```shell\nyarn local:migrate:up\nyarn local\n```\n\n- `yarn install` - Install yarn dependencies\n- `yarn local:db:up` - Create a new database (with docker-compose)\n- `yarn local:migrate:up` - Send migrations to database (Create schema in the database)\n- `yarn local` - Run local server // @TODO ~ put this inside docker compose with volume and nodemon\n- `yarn uninstall` - Remove docker containers (then you can safely remove this folder)\n\n## Example Queries\n\nYou can see a list of test queries to execute on graphql playground.\n\nSee [Example Queries](./docs/ExampleQueries.md)\n\n## Tech Stack\n\n- Typescript\n- Nexus (nexus-future)\n- Docker compose - Right now it's only creating a new database // @TODO ~ put this server inside a container and create a volume\n\n## System Requirements\n\n- Node\n- Yarn (or npm)\n- Docker compose\n- A developer (did you get it?)\n\n## Environment Variables\n\n- `NODE_ENV=`local\n- `MASTERKEY`=localmasterkey\n- `PORT`=4001\n- `DB_URL`=mysql://prisma:prisma@localhost:3310/workouts\n\n\u003e @TODO ~ If you define a masterkey, then you need to send it in the header of all requests to this graphql server. More details below on Masterkey Authentication.\n\n## Manual Hooks\n\nSomethings are not automatic. Here is what you need to do when you do what you do.\n\n| When you... | Do this!\n| --- | ---\n| Change file: `prisma/schema.prisma` | Run `yarn local:migrate:save \u0026\u0026 yarn local:migrate:up`\n| Change file: `local.yml` | Run `yarn local:db:up`\n\n- `yarn local:migrate:save` - Update the folder prisma/migrations with the new schema definition on schema.prisma (`prisma2 migrate save --experimental`)\n- `yarn local:migrate:up` - Sync database with the newly created migrations (`prisma2 migrate up --experimental`)\n- `yarn local:db:up` - Roda o banco de dados local (via docker-compose)\n\n## Masterkey Authentication\n\n@TODO ~ Not implemented yet.\n\nIf you define a MASTERKEY env variable, then this string must be send to every API call.\n\nHeader:\n\n```\nX-Masterkey: XXXXXXX\n```\n\n\u003e The masterkey config is located at `config/*.env`.\n\n## Tags\n\n\u003e This project comes with a default schema with \"tags\". This allows you to immediately test your API and maybe you even like the initial schema and start building your software with tags...\n\nA `Todo` may have as many tags as the client wants.\n\nWhen you query `todos(tags:[\"tag1\",\"tag2\"]) { ... }` you need to send an array with tags. The todos must be related to **all the tags you send** (but it may have more).\n\nIf you pass an empty tags array, then all todos are returned.\n\n## @TODO\n\n- Steps to deploy in production\n- Add seed todos\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroenv%2Fgraphql-prisma-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicroenv%2Fgraphql-prisma-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroenv%2Fgraphql-prisma-boilerplate/lists"}