0.1.0 • Published 5 years ago

tm-components-test v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 years ago

tm-components

This project is a fork from TM Boilerplate Base. To pull in latest changes git pull upstream master while being on master branch of your project.

Usage if installed from npm

  1. yarn add 'tm-components'
  2. import Label from 'tm-components/label';

Usage if installed from git url

  1. yarn add https://github.com/kushalmahajan/tm-components.git
  2. import Label from 'tm-components/dist/label';

Contribution

  1. git clone https://github.com/kushalmahajan/tm-components.git
  2. yarn install
  3. yarn start
  4. do your thing and submit a PR

What's more in this from base repo?

  1. Storybook configuration

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.

yarn run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

See the section about deployment for more information.

yarn run build:staging

Builds the app for staging to the build folder. It picks up the environment from the .env-cmdrc file staging object

yarn run lint

It simply runs tslint to list down the errors.

yarn run lint:fix

It fixes the errors if any of the lint

yarn analyze

This checks for bundle size and spins up a separate link for a view window

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.