ma-hab-test

MA-HAB-TEST PROJECT

MA-HAB-TEST PROJECT is made up of two modules, designed to be part of a complex frontEnd platform:

• ma-hab-test-budget
• ma-hab-test-design-system - uploaded to npm -

Version: 1.0.0

Technological stack

This module is build with the following technologies:

• React & React-dom
• i18next

There are some others techs in development to help us make our code more eficient, reusable, maintenable and scalable:

• Webpack
• Storybook
• Babel
• Prettier
• eslint

How do I get set up?

To quickstart, execute npm install in the root.

• Development commands:

  • npm run storybook:

    Runs storybook dev tool, maiking posible to change app params (like language) on the fly, and to play with the app.

  • npm run start:

    The start script will build a single entry point in src/entry, wich will be served by webpack-dev-server. The app uses the src/indexTemplate.js as a template for build that real entry point.

    By default, the command will build the en_GB app version. Example: npm start

    For custom builds, use the LANGUAGE params. Example: LANGUAGE=es-ES npm start

    Webpack-dev-server will serve the app with the 'public/index.html' content in DOM. The hot mode keeps watching your changes in the code, and re-load the page with the current status.

    Is important to note that if you need to change the index.js your changes must to be done in src/index_template.js, since the others are generated files and are no versioned.

    **This module is designed to be part of a more complex system, where the parent-module will import the desired entry point for each language. This way we ensure that the browser is downloading just the code that it needs, avoiding to load unnecessary text jsons **

  • npm run test:

    Runs js test.

  • npm run precommit:

    Formats your code following the code style guide and runs js test.

• Producction commands:

  • npm run prepack:

    Launched before publish.The prepack script will build a multiple entry points, ready for being transpiled. The app uses the src/indexTemplate.js as a template for build that real entry points.

    The script checks the code style and js test too and, if thats correct, runs Babel and put all the transpiled code in dist/, ready to be published and imported in other/s module/es.

• Owner: Maria Alvarez Gutierrez.