/react-start-template

Primary LanguageTypeScriptThe UnlicenseUnlicense

This project was bootstrapped with Create React App.

INCLUDED

  • React
  • Create React App
  • Typescript
  • Storybook
  • Husky
  • Prettier
  • Stylelint
  • Tslint

REQUIREMENTS

Install

  • nvm

SETUP

First we ensure to have the correct nvm version

nvm install

To install the dependencies run

npm install

DEVELOPING

Available Scripts

In the project directory, you can run:

npm 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.

npm run storybook

Runs the storybook component documentation.

The page will reload if you make edits.

npm run build-storybook

Builds the storybook component documentation if you plan to upload it to a server as static files.

npm run analyze

Builds the project and analyze the different build files.

npm run stylelint

Linting all css and scss files.

npm run stylelintAndFix

Fixes all auto-fixable linting errors on all css and scss files.

npm run tslint

Linting for all javascript and typescript files. (This should be moved to use eslint)

npm run tslint

Fixes all auto-fixable linting errors on all javascript and typescript files. (This should be moved to use eslint)

npm test

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

npm 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.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.