neeto-wheel-nano

The neeto-wheel-nano acts as the source of truth for the new nano's structure, configs, data etc.

Contents

1. Development with Host Application
   • Engine
     • Installation
     • Usage
   • Frontend package
     • Installation
     • Instructions for development
     • Usage
2. Instructions for Publishing

Development with Host Application

Engine

Installation

1. Add this line to your application's Gemfile:

    source "NEETO_GEM_SERVER_URL" do
      # ..existing gems
   
      gem 'neeto-wheel-engine'
    end
   

2. And then execute:

   bundle install
   

3. Add this line to your application's config/routes.rb file

    mount NeetoWheelEngine::Engine, at: "/neeto_wheel"
   

4. Add required migrations in the db/migrate folder. Run the following commands to copy the migrations from the engine to the host application.

   bundle exec rails neeto_wheel_engine:install:migrations
   bundle exec rails db:migrate
   

Usage

1. Replace NeetoWheelNano with your project name

   Create a script.rb file in the project root and paste the script from the following file.

   Replace project name script

2. Run the file using the following command:

      ruby script.rb
   

Notes ⚠️

• Don't commit this file.
• Project name should be given in PascalCase.

Frontend package

Installation

1. Add the neeto-wheel-frontend package to the package.json

   yarn add @bigbinary/neeto-wheel-frontend
   

Instructions for development

Check the Frontend package development guide for step-by-step instructions to develop the frontend package.

Usage

1. Import WelcomeScreen component from "@bigbinary/neeto-wheel-frontend"

   import React from "react";
   
   import { WelcomeScreen } from "@bigbinary/neeto-wheel-frontend";
   
   const App = () => <WelcomeScreen />;
   
   export default App;
   

Instructions for Publishing

Consult the building and releasing packages guide for details on how to publish.