Git Product home page Git Product logo

monkjs's Introduction

@monkvision/monkjs npm latest package

Get a fully automated damage report classified by type, car parts, position and severity.

See full documentation on monkvision.github.io/monkjs

Modules overview

yarn add @monkvision/corejs @monkvision/camera @monkvision/sights @monkvision/visualization @monkvision/toolkit @monkvision/ui

Bulk CLI adding all of our packages

Pure JS API implementing schema's and reducers ready to be imported in your app. Uses Axios, Redux & Normalizr for an optimized and state control. Can also be used only to make requests directing our Monk core API.

@monkvision/corejs

Pure JSON collection of Sights & Overlays. A sight is an Object of data defining a Taking Picture point of view. An overlay is the graphic SVG represantion of a sight.

@monkvision/sights

This is the spine of our front-end components. It allows taking high quality picture in Native & Web platforms. It also checks about compliance (blur, exposure, angle, visible car parts...) and guides users to snap their best pictures of the vehicle.

@monkvision/camera

This is the voice explaining all the data we get. Built with React and React Native, it shows with smart components where are the damages, on a simple list or in a 2D vehicle representation.

Designed by our best UI/UX people, our visualization components are tailored for you and fully customizable.

For example: having damages on a red car ? Boxing damages in green because green is better seen on red.

@monkvision/visualization

🪲 Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Auth0 Responsible Disclosure Program details the procedure for disclosing security issues.

For Monk related questions/support please use the Support Center.

⚖️ License

This project is licensed under the Clear BSD license. See the LICENSE file for more info.

What's next?

You can start following our guides on first, setting up depending on the workflow you use, then taking pictures.

Are you starting a new application? We recommend the use of Expo. Already have a React Native app? Some implementation may be required to manage iOS, Android and Web compatibility as much as possible.

monkjs's People

Contributors

natsukiai avatar benhakimilyass avatar alexandregmonk avatar dependabot[bot] avatar alexandre-em avatar artemisart avatar rb46546741 avatar franklinkemta avatar zamen avatar souyahia-monk 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.