Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ovyerus/prismaliser
Visualise your Prisma schema!
https://github.com/ovyerus/prismaliser
graph hacktoberfest nextjs nix-flake prisma react react-flow typescript visualization
Last synced: 3 days ago
JSON representation
Visualise your Prisma schema!
- Host: GitHub
- URL: https://github.com/ovyerus/prismaliser
- Owner: Ovyerus
- License: mit
- Created: 2021-07-25T10:23:53.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2024-11-29T13:10:13.000Z (23 days ago)
- Last Synced: 2024-12-13T06:02:43.252Z (10 days ago)
- Topics: graph, hacktoberfest, nextjs, nix-flake, prisma, react, react-flow, typescript, visualization
- Language: TypeScript
- Homepage: https://prismaliser.app
- Size: 3.56 MB
- Stars: 873
- Watchers: 6
- Forks: 46
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
---
**Prismaliser** is a visualisation webapp for [Prisma](https://prisma.io)
schemas. It allows you to visually explore your schema and the relations between
your models, by showing links between the different types of relations in the
schema (many-to-many, one-to-many, one-to-one), similar to an
[Entity-relationship model](https://en.wikipedia.org/wiki/Entity-relationship_model).
Prismaliser is a fully open-source Next.js application and is easily self-hostable if
you wish to, but a hosted version is also available at
[prismaliser.app](https://prismaliser.app) if you just want to use it instead.
## Installation
Prismaliser is a Next.js application, and as such it requires
[Node.js](https://nodejs.org) to be installed in order to run.
[Yarn](https://yarnpkg.com) is also recommended as it has a (subjectively) nicer
CLI interface.
With Node installed, and the repository cloned, you can simply run the following
commands to get it running:
```bash
yarn install # or `npm install`
yarn build # or `npm run build`
yarn start # or `npm start`
```
The latter command can be run in anything like PM2, systemd or any other process
daemon of your choice.
Or if you're looking to run it for development purposes, you can use the
following commands instead:
```bash
yarn install # or `npm install`
yarn dev # or `npm run dev`
```
### Docker
A
[Docker image](https://github.com/Ovyerus/prismaliser/pkgs/container/prismaliser)
is also available if that's more your thing.
```bash
$ docker run -p 3000:3000 ghcr.io/ovyerus/prismaliser
```
or if you wanna live on the edge and run the dev branch
```bash
$ docker run -p 3000:3000 ghcr.io/ovyerus/prismaliser:dev
```
## Roadmap
This is a list of what I've currently got planned for the future. I'm open to
accepting PRs for any of these, but I'd prefer it if you could first open an
issue regarding it so we can discuss it/make sure there's not multiple people
working on the same thing.
I'm also open to PRs for other features not listed here, but also please open a
corresponding issue to discuss it, just like above.
- [ ] Multi-history support (user defined saves).
- [x] Sharing a schema with other users via a generated link (similar to
TypeScript's [playground](https://www.typescriptlang.org/play/)).
- [ ] Saving node positions across page resets.
- [ ] Autocomplete for the editor (very big, Monaco is a bit fiddly at times,
would probably need to do some looking at the VSCode plugin for Prisma to
figure out some stuff).
## License
Prismaliser is licensed under the MIT License - see the [LICENSE](LICENSE) file
for details.