@rapyuta-robotics/spirit NPM

@rapyuta-robotics/spirit

The first version of Spirit is finally here!

Design concept by Juho can be found in this link: https://www.rapyuta-robotics.com/ja/character/

How to add this package to your project

In your project's directory, run yarn add @rapyuta-robotics/spirit

import { SpiritWrapper } from '@rapyuta-robotics/spirit';

const YourComponent = () => {
  return (
    <>
      ...
      <SpiritWrapper width={400} height={300} />
    </>
  )
}

Preview in RobotUI:

https://github.com/rapyuta-robotics/spirit/assets/117139683/b0b5ca27-0ad6-40aa-b9b5-bb25a9fa9d05

How to develop this package locally

Start development: 1. First, make sure that you have added this package to your project (see: How to add this package to your project) 2. In this package's 📦 directory, run yarn link to create the symlink 3. In this package's 📦 directory, run yarn start to watch this package's file changes and rebuild automatically 4. In your project's 📝 directory, run yarn link @rapyuta-robotics/spirit to establish the symlink 5. Your project is now referencing to the local copy of this package everytime you import such as import { helloWorld } from '@rapyuta-robotics/spirit' 6. When you edit the code of this package, your project will hot-reload and reflect the new changes

Stop development: 1. In your project's 📝 directory, run yarn unlink @rapyuta-robotics/spirit to disband the symlink (NOTE: you need to do this before step (3), otherwise the unlink will fail. In the case that you mistakenly run (3) before (1), run yarn link in this package's 📦 directory and restart from (1)) 2. In your project's 📝 directory, run yarn install --force to ensure that it's using the correct remote version of @rapyuta-robotics/spirit 3. In this package's 📦 directory, run yarn unlink to cancel the symlink

How to publish a new version

A new version will be published to NPM everytime a new release is created

The workflow shall be: 1. Create a new release targeting devel. No release branch should be created as we are using trunk-based development approach. 2. Tag of the new release should follow semantic versioning with breaking change (compatibility issue).feature update.bugfix patches -> (x.y.z) 3. Once release is created, github action will automatically publish it to npmjs.

FAQs

If CI fails when trying to publish npm package, there is a chance that the project does not have access to RR_NPM_TOKEN in organization's secrets. Contact michael.orr@rapyuta-robotics.com when such case occurs.