Skip to content

@Rankmi Rankmi SPA

performance-results-app 1.8.4

Install from the command line:
Learn more about npm packages
$ npm install @rankmi/performance-results-app@1.8.4
Install via package.json:
"@rankmi/performance-results-app": "1.8.4"

About this version

Performance Results App

Main tech stack

  • Node.js
  • Yarn
  • React
  • Jest
  • Axios

Requirements

  1. Node 12.22.12
  2. A wrapper for translations
  3. Set your token in .npmrc

Github Token in .npmrc. See CREATE TOKEN

Yarn commands

Execute any command like yarn COMMAND.

Command Description
prebuild Run build antd css
build Run build ouput
prepublish Run build when run npm publish
test:build Run local build for simulate publish ouput
test:lint Run eslint rules
lint:fix Run fixed from eslint ouput
start Run project
test Run test suites
pack Create a local version

Installation

Publish version

npm i "@rankmi/performance-results-app"
yarn add "@rankmi/performance-results-app"

Non publish version

  1. Generate a non publish version of performance-results-app with:
yarn pack
  1. Install the generated pack on you project:
yarn add <path-of-pack>

Note: <path-of-pack> is the path of the .tar file generated by yarn pack

Usage

Css:

import 'performance-results-app/dist/index.css'
import 'performance-results-app/dist/antd.css'

Import antd.css file only when component is used outside of rankmi app.

PerformanceResultsAdmin:

import { PerformanceResultsAdmin } from "@rankmi/performance-results-app"

Props:

name type description required
locale json object add translation keys
  • default locale prop
{
  alert: {
    message: 'La pestaña de Administración estará visible por defecto para los usuarios administradores en el menú',
    error: 'Ocurrió un error, por favor intente mas tarde',
    success: 'Cambios guardados existosamente'
  },
  title: 'Configuración',
  table: {
    switch: {
      yes: 'Si',
      no: 'No'
    },
    section: 'Secciones',
    admin_tab: 'Mostrar evaluaciones',
    evaluation_tab: 'Mostrar resultados',
    admin_tab: 'Administración'
  }
}

Example:

import { PerformanceResultsAdmin } from "@rankmi/performance-results-app"

<PerformanceResultsAdmin locale={translationsKeys} />

PerformanceResultsHome:

import { PerformanceResultsHome } from "@rankmi/performance-results-app"

Props:

name type description required
locale json object add translation keys
  • default locale prop:
{
  tabs: {
    results_tab: 'Resultados',
    admin_tab: 'Administración',
    evaluation_tab: 'Evaluación'
  }
,
  emptyState: {
    message: 'No hay información disponible. Por favor revise la configuración o intente mas tarde'
  }
}

Example:

import { PerformanceResultsHome } from "@rankmi/performance-results-app"

<PerformanceResultsHome locale={translationsKeys} />

Develop

In order to develop on this package, you will need:

  1. Run yarn install and yarn start
  2. Set up the emulator

Author

Rankmi Spa, [email protected]

Support

  • Slack: Manuel Rodrigues
  • Github: manuelror

Do you need more info? Write me 💻

License

Rankmi News is available under the MIT license. See the MIT LICENSE link for more info.

Details

Assets

  • performance-results-app-1.8.4.tgz

Download activity

  • Total downloads 3
  • Last 30 days 3
  • Last week 3
  • Today 0

Recent versions

View all