Prisma Framework Specifications

This repository contains specifications for Prisma Framework:

• About this repository
• Specifications
  • User facing parts
  • Internal parts
  • Organisation
    • Process
    • Meta
  • Style Guide

About this repository

This repository is designed to help different groups of people:

• Prisma Product: Specify and work on new and existing functionality 🛫
• Prisma Engineering: Collaborate with Product and use specs as base for implementation work 👩‍💻
• Prisma Community and Users: Follow and understand Prisma Framework development 👽

Besides the specifications linked below, most of the work here happens in the repo issues and pull requests.

Specifications

User facing parts

Prisma Framework consists of several tools:

• Prisma Schema Language (PSL)
• Tools
  • Prisma CLI - setup and introspection
  • Prisma Client - data access
    • Prisma Client JS
    • Prisma Client Go
  • VSCode Prisma - PSL formatting and linting
  • Prisma Migrate - migrate databases
  • Prisma Studio - GUI

Internal parts

It also has several internal parts:

• SDK
  • JS SDK
    • Generators
    • Engine Runtime
• Binaries
• Errors

Organisation

We don't only spec the software itself, but also how we work on it and on these sepcs:

Process

• GitHub labels
• Issue Triage
• Repositories

Meta

• Specs
• Table of Contents

Style Guide

Please run prettier on every .md file before committing with the following configuration (ideally via this VSC extension):

  "prettier.singleQuote": true,
  "prettier.trailingComma": "all",
  "prettier.semi": false,