@bigbinary/neeto-crm-frontend

neeto-crm-nano

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

Contents

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

Development with Host Application

Engine

Installation

• Add this line to your application's Gemfile:

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

• And then execute:

  bundle install
  

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

   mount NeetoCrmEngine::Engine => "/neeto_crm_engine"
  

• 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_crm_engine:install:migrations
  bundle exec rails db:migrate
  

Usage

• Replace NeetoCrmNano 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

• 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

• Add the neeto-crm-frontend package to the package.json

  yarn add @bigbinary/neeto-crm-frontend
  

Instructions for development

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

Usage

• Import WelcomeScreen component from "@bigbinary/neeto-crm-frontend"

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

Instructions for Publishing

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