Code Monkey home page Code Monkey logo

prisma-oxigen's Introduction

prisma-oxigen

Prisma Oxidized Generator (Oxigen) is a crate designed to simplify the creation of Prisma generators. It aims to provide essential helper functions and utilities similar to @prisma/generator-helper but for Rust.

Key Features:

  • Full Implementation of Prisma's JSONRPC Interface, ensuring seamless communication with Prisma engines.
  • Extensive Type Support, encapsulating Prisma's model and field types within Rust's strong type system.
  • Helper Functions to streamline the creation of Prisma generators, making it easier to extend Prisma's capabilities or integrate with other tools and frameworks.

Getting Started

To use Oxigen in your project, you will need to have Rust and Cargo installed on your system. If you don't have them installed, visit rust-lang.org to get started.

Installation

Add prisma-oxigen to your Cargo.toml:

[dependencies]
prisma-oxigen = "1.0.0"

Then, run cargo build to download and compile the package along with its dependencies.

Basic Usage

Oxigen allows you to extend Prisma by writing your custom generators. Generators are used to transform the Prisma schema into code or other outputs. Here's a skeleton to start writing a custom generator:

use prisma_oxigen::modules::oxigen::{generate_callback, generator::Generator, manifest_callback};

fn manifest(params: manifest_callback::Params) {
}

fn generate(params: generate_callback::Params) {
}

fn main() {
    Generator::new(Some(manifest), Some(generate));
}

Documentation

For more detailed information on the API and advanced usage, refer to the prisma-oxigen documentation page.

Contributing

Contributions are welcome! Whether it's submitting a bug report, a feature request, or a pull request, all forms of contributions help improve Oxigen.

License

prisma-oxigen is distributed under the terms of the Apache 2.0 license. See LICENSE for details.

Special Thanks

I want to thank everyone who has worked on the following projects, as without them Oxigen wouldn't exist:

prisma-oxigen's People

Contributors

emilio-toledo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.