Skip to content

nejcrogelsek/react-project-template-npm

Repository files navigation

Tutorial


Table of Contents


Description

Tutorial.

Technologies

  • ReactJS
  • Typescript
  • Git
  • GitHub

Back To The Top


Available Scripts

In the project directory, you can run:

npm run start:clean

Remove node_modules & package-lock.json files. Then it runs: npm i to install all packages & finally npm start to run 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 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 test

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

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

npm generate:icons

This command generates new icons. Before running this command make sure you have:

  1. At least one .svg file inside src/assets/icons (Example for navbar home icon: https://icons.getbootstrap.com/icons/house-door-fill/)
  2. Run: npm run generate:icons
  3. Format file src/components/shared/Icon/Icon.generated.tsx to get rid of eslint/prettier errors.

npm run generate:page PageName

Generates new page with specified name.

npm run generate:component ComponentName

Generates new component with specified name.

Check for updates

  • npm run update:check - Check for any packages updates.
  • npm run update:single packageName - Updates one package.
  • npm run update - Updates all packages.

Prettier

  • npm run code:check - Check for any prettier errors.
  • npm run code:format - Format code.
  • npm run code:format:specific-file - Format specific file.

eslint

  • npm run lint - Check for any eslint errors.
  • npm run lint:fix - Fix some of the errors.

Back To The Top


Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Back To The Top


References

Back To The Top

Author Info

Back To The Top

About

React boilerplate code with NPM. Starter template.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published