Giter VIP home page Giter VIP logo

jopi.js's Introduction

Jopi.js

Just One Perfect Interface

Installation

For your projects

If you want to install jopi.js in your proyect, you should read the package installation guide.

For package development

If you want to work on jopi.js you should install the dependencies and then start the development server.

For yarn:

$ cd jopi.js
$ yarn
$ yarn run dev

For npm:

$ cd jopi.js
$ npm (i | install) # Use one of these options
$ npm run dev

Packages we use to build Jopi:

  • Storybook (for building isolated components)
  • React
  • Styled-components (CSS-in-JS)
  • Styled-system (Style props for rapid UI development)
  • Lerna.js (monorepo and tool for publish packages used in CI)
  • Framer Motion (animations)

Things to improve

  • STRUCTURE: Upgrade dependencies (Framer Motion)
  • STRUCTURE: Upgrade dependencies (storybook 5.3)
  • DOCS: Improve documentation of the packages.

(*) Today, every visual element is a package in npm. Maybe we should group them by elements (forms, core, extra, theme, hooks)

New thigs to do

  • PACKAGES: Carousel.
  • PACKAGES: Textarea - restyling.
  • PACKAGES: Alert - restyling.
  • PACKAGES: Box - restyling.
  • PACKAGES: List - restyling.
  • PACKAGES: Paginator - restyling.
  • PACKAGES: Label - restyling.
  • PACKAGES: Table filter.

QA:

How can i build my own theme for jopi.js?

You can check how to theming and follow the theme specification.

Can i use Jopi.js in a typescript project?

Yes you can, we are using it. The only extra thing that you need to do is crate a declarations.d.ts file on your project and declare jopi.js packages that you would like to use. Like:

declare module '@oneloop/jopijs'
declare module '@oneloop/theme'
declare module '@oneloop/hooks'
How can i manually publish a package to NPM?

For this proccess we use lerna cli. Basically, we use 2 commands to achieve the goal.

lerna version

To generate new versions of the modified packages. Maybe, sometimes, we need to use the --force-publish option of the command to force the generation of new versions.

lerna publish

Publish packages that have changed since the last release. Here we have 2 options for publish. from-package: explicitly publish packages where the latest version is not present in the registry. from-git: Explicitly publish packages tagged in the current commit

For more info check lerna docs.

jopi.js's People

Contributors

bsabatino avatar ldebenedettinavent avatar aguescribano87 avatar dependabot-preview[bot] avatar iarah avatar martinacastillor avatar emanuelheredia avatar eulke-oneloop avatar war-tortle avatar dependabot[bot] avatar manuel-tokko avatar marcopuccio avatar aperal avatar charce36 avatar

Stargazers

Alex Chaparro avatar  avatar Luckystoned avatar  avatar

Watchers

James Cloos avatar Luis Facciolo avatar  avatar Leonardo Bispo avatar Jo Salgado avatar  avatar Juan Manuel Covellone 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.