Skip to content

What you need to create your own React component using typescript.

Notifications You must be signed in to change notification settings

atto-byte/react-ts-component-starter

 
 

Repository files navigation

React Typescript Component Starter

Starter project for creating your own React component with TypeScript. This component is just a demo of what you get when you publish it.

Edit

  • Edit src/index.tsx and src/style.css

Build

  • npm i to install all dependencies.
  • npm run build to build your component
  • npm link to create a symbolic link from the global folder to your component

Run Tests

  • npm run test to run tests
  • npm run test:watch to see test status while your develop

Develop

  • Create a new React app using for example create-react-app. This app will be used for testing your component.
  • Import your react component
  • npm link <your-component> to link node_modules/<your-component> in your application to the global folder. So when importing your component it will call on the built version in the component project.
  • npm start in your component folder. You will see that every time you change something it will automatically rebuild.
  • Run your application. If using create-react-app, run it with npm start.
  • Do some changes in the component and see that the application gets updated.

Publish

  • Edit package.json by adding the correct information like name and author.
  • Create a NPM account
  • npm login with your account information
  • npm publish to publish your component so other can enjoy its existence.

Links

React

TypeScript

Webpack

Inspired by Broda Noels blog.

About

What you need to create your own React component using typescript.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 70.2%
  • TypeScript 19.8%
  • CSS 10.0%