luchoPenafiel/scan-id

ScanId

Technology

Main stack

This project was bootstrapped with Create React App and TypeScript.

API

The API used for interaction with the camera is:

• MediaDevices.getUserMedia()
• MediaStreamTrack.stop()

Styles

The framework used for styling is Styled-components.

Test

This proyect use React Testing Library to implment test.

Best practices

We recommend read this articules for contributing:

• Event handler naming in react
• Conventional Commits
• How to write your CSS

Folder Structure

.
├── public                         # All public files.
    ├── fonts                      # Custom fonts.
    ├── icons                      # SVG icons.
    ├── images                     # Placeholder images.
├── src
    ├── api                        # API calls.
    ├── components                 # The stateless reusable components.
        ├── Component.tsx          # The component itselft.
        ├── Component.styles.tsx   # Styles
        ├── Component.test.tsx.    # Tests
    ├── hooks                      # Custom hooks.
    ├── views                      # Main views.
└── README.md                      # The first page the user will see when visiting the repo.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.