| <div align="center"> |
| <h1>Prisma</h1> |
| <a href="https://www.npmjs.com/package/prisma"><img src="https://img.shields.io/npm/v/prisma.svg?style=flat" /></a> |
| <a href="https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a> |
| <a href="https://github.com/prisma/prisma/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-blue" /></a> |
| <a href="https://pris.ly/discord"><img alt="Discord" src="https://img.shields.io/discord/937751382725886062?label=Discord"></a> |
| <br /> |
| <br /> |
| <a href="https://www.prisma.io/docs/getting-started/quickstart">Quickstart</a> |
| <span> β’ </span> |
| <a href="https://www.prisma.io/">Website</a> |
| <span> β’ </span> |
| <a href="https://www.prisma.io/docs/">Docs</a> |
| <span> β’ </span> |
| <a href="https://github.com/prisma/prisma-examples/">Examples</a> |
| <span> β’ </span> |
| <a href="https://www.prisma.io/blog">Blog</a> |
| <span> β’ </span> |
| <a href="https://pris.ly/discord">Discord</a> |
| <span> β’ </span> |
| <a href="https://twitter.com/prisma">Twitter</a> |
| <br /> |
| <hr /> |
| </div> |
|
|
| ## What is Prisma? |
|
|
| Prisma is a **next-generation ORM** that consists of these tools: |
|
|
| - [**Prisma Client**](https://www.prisma.io/docs/concepts/components/prisma-client): Auto-generated and type-safe query builder for Node.js & TypeScript |
| - [**Prisma Migrate**](https://www.prisma.io/docs/concepts/components/prisma-migrate): Declarative data modeling & migration system |
| - [**Prisma Studio**](https://github.com/prisma/studio): GUI to view and edit data in your database |
|
|
| Prisma Client can be used in _any_ Node.js or TypeScript backend application (including serverless applications and microservices). This can be a [REST API](https://www.prisma.io/docs/concepts/overview/prisma-in-your-stack/rest), a [GraphQL API](https://www.prisma.io/docs/concepts/overview/prisma-in-your-stack/graphql) a gRPC API, or anything else that needs a database. |
|
|
| **If you need a database to use with Prisma ORM, check out [Prisma Postgres](https://www.prisma.io/docs/getting-started/quickstart-prismaPostgres?utm_source=npm&utm_medium=readme) or if you are looking for our MCP Server, head [here](https://github.com/prisma/mcp).** |
|
|
| ## Getting started |
|
|
| The fastest way to get started with Prisma is by following the [**Quickstart (5 min)**](https://pris.ly/quickstart). |
|
|
| The Quickstart is based on a preconfigured SQLite database. You can also get started with your own database (PostgreSQL and MySQL) by following one of these guides: |
|
|
| - [Add Prisma to an existing project](https://www.prisma.io/docs/getting-started/setup-prisma/add-to-existing-project/relational-databases-typescript-postgresql) |
| - [Set up a new project with Prisma from scratch](https://www.prisma.io/docs/getting-started/setup-prisma/start-from-scratch/relational-databases-typescript-postgresql) |
|
|
| ## Community |
|
|
| Prisma has a large and supportive [community](https://www.prisma.io/community) of enthusiastic application developers. You can join us on [Discord](https://pris.ly/discord) and here on [GitHub](https://github.com/prisma/prisma/discussions). |
|
|
| ## Security |
|
|
| If you have a security issue to report, please contact us at [security@prisma.io](mailto:security@prisma.io?subject=[GitHub]%20Prisma%202%20Security%20Report%20). |
|
|
| ## Support |
|
|
| ### Ask a question about Prisma |
|
|
| You can ask questions and initiate [discussions](https://github.com/prisma/prisma/discussions/) about Prisma-related topics in the `prisma` repository on GitHub. |
|
|
| π [**Ask a question**](https://github.com/prisma/prisma/discussions/new) |
|
|
| ### Create a bug report for Prisma |
|
|
| If you see an error message or run into an issue, please make sure to create a bug report! You can find [best practices for creating bug reports](https://www.prisma.io/docs/guides/other/troubleshooting-orm/creating-bug-reports) (like including additional debugging output) in the docs. |
|
|
| π [**Create bug report**](https://pris.ly/prisma-prisma-bug-report) |
|
|
| ### Submit a feature request |
|
|
| If Prisma currently doesn't have a certain feature, be sure to check out the [roadmap](https://www.prisma.io/docs/more/roadmap) to see if this is already planned for the future. |
|
|
| If the feature on the roadmap is linked to a GitHub issue, please make sure to leave a +1 on the issue and ideally a comment with your thoughts about the feature! |
|
|
| π [**Submit feature request**](https://github.com/prisma/prisma/issues/new?assignees=&labels=&template=feature_request.md&title=) |
|
|
| ## Contributing |
|
|
| Refer to our [contribution guidelines](https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md) and [Code of Conduct for contributors](https://github.com/prisma/prisma/blob/main/CODE_OF_CONDUCT.md). |
|
|
| ## Tests Status |
|
|
| - Prisma Tests Status: |
| [](https://github.com/prisma/prisma/actions/workflows/test.yml) |
| - Ecosystem Tests Status: |
| [](https://github.com/prisma/ecosystem-tests/actions) |
|
|