Luiza Labs Challenge

This repo has all the components needed for the application.

Tests with:

• Mocha
• Chai
• Sinon
• Enzyme

Code coverage with:

• Instanbul (Nyc)

Git Hooks with:

• Husky

• Storybook

Getting Started

If you want to use this components in your application please install the pckage via npm

npm i luizalabs-challenge

after just import the Map component in your app

Using the Component

import React from 'react';
import LuizaMaps from 'luizamaps-challenge';

const Component = () => (
    <LuizaMaps />
);

export default Component;

Writing your code

Write your component code on src/Main.js, you can create another files for composable components also.

import React from 'react';
import PropTypes from 'prop-types';

const Component = ({ name }) => (
    <h1>Hello {name}!</h1>
);

Component.propTypes = {
    name: PropTypes.string.isRequired,
};

export default Component;

Writing Stories

Stories are like behavior or states that our components should have. Such as an activated button, labels, whatever your component can change by props/states.

You can also see them as user stories for the agile development.

To understand more about that, I suggest you to read the storybook stories guide. Follow the example above:

storiesOf('Component', module)
    .add('with lyef name', () => (
        <Component name="lyef" />
    ))
    .add('with another name', () => (
        <Component name="another" />
    ))

Every new story will be available on the left side panel of React Storybook to see different cases.

Running your code

Just use npm start, Runs the app in development mode. Open http://localhost:9001 to view it in the browser.

The page will reload if you make edits and you will see the build errors and lint warnings in the console.

Running tests

We encourage everyone to write tests to your components, this can help us to create a more maintainable and free of bugs component. To do that, we create 3 tasks:

• npm test: run your tests in a single-run mode.
• npm run test:tdd: run and keep watching your test files.
• npm run test:coverage: prints and create html files by istanbul coverage.

Linting your code

In order to keep your code clean and consistent we use eslint with Airbnb preset. We have 2 tasks for this:

• npm run lint: lint all files searching for errors.
• npm run lint:fix: fix automaticaly some lint errors.

Deploy your component

You can deploy your component (inside Storybook) to github pages running the command npm run deploy-storybook.

Environment

React Storybook - to tell stories with different behaviors of the component and provide an example page.

Style Guide

• EditorConfig - standardize some general settings among multiple editors
• ESLint - for reporting the patterns of code
  • Airbnb JavaScript Style Guide
  • Plugins
    • React
    • A11y
    • Import

Tests

• Mocha - test framework
• Chai - assertions
• Enzyme - shallow component
• Jsdom - mock the browser