cherls / specs

Specifications for Prisma Framework

Prisma Framework Specifications

This repository contains specifications for Prisma Framework:

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

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 - Overview of the Tools ❌
  • CLI - setup and introspection 🚧
  • Studio - GUI 🚨
  • Photon - data access ❌
    • Photon.js 🚨
    • Photon.go 🚨
  • Lift - migration 🚨
  • VSCode Prisma - PSL formatting and linting ❌

Internal parts

It also has several internal parts:

• SDK ❌
  • JS SDK ❌
    • Generators 🚨
    • Engine Runtime 🚨
• Binaries 🚨
• Capabilities 🚧
• 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 ✅
• Release Milestones ✅

Meta

• Specs 🚧
• Table of Contents ✅

---

Emoji key:

• ❔ - unknown state
• ✅ - current, stable
• 🚧 - work in progress (see Pull Requests)
• 🚨 - outdated, needs work
• ❌ - does not exist yet

Build status:

• CLI Netlify Status: