@timmons-group/shared-react-components v1.0.2
Timmons Group Shared React Components
Overview 📚
This repo contains the source code for the Timmons Group Shared React Components npm library.
Core Files/Folders 📂
src/helpers
- Helper/utility functions.
src/hooks
- Reusable hooks for generic routines such as auth and data fetching.
src/stories
- Storybook stories and reusable components.
Install Dependencies 🧩
- Install the
LTS
version of Node JS npm i
How to Run Storybook Locally 📖
Storybook will let you develop locally without the need to integrate this lib with an application (see the section below on Running Locally with a Target Project 🏃♂️). This sort of development is best suited for isolated component
development.
cd src
npm start
How to Run Locally and Link to a Target Project 🏃♂️
We can run this library within a target project/application by using npm link
. This sort of development is best suited for situations where you need to work on the hooks
/helpers
or want to do some manual integration testing of the components
within your target project.
- Delete the
@timmons-group
folder in thenode_modules
folder of the target project. - Boot up the target project's dev web server and let
webpack
fail (due to the goodies we just deleted). - Stop your dev web server.
- In this repo run
npm run build:package
- In this repo run
npm link
- In the target repo run
npm link @timmons-group/shared-react-components
- Restart the target repo's web server and you should be all set
- Make changes to this shared component repo and then run
npm run build:package-localdev
(or indiviudally run any of the commands within this command if you specifically know which of the Core Files 📂 you are updating - which hopefully you do 🧙♂️).
To remove the npm link
, simply run npm i
in the target project (worst case scenario, you may need to delete some stuff in node_modules
of the target proejct and re- npm i
if the first npm i
doesn't work).
How to Build 🔨
npm run build:package
How to Publish to NPM 📦
TODO: add some goodies here about tagging
https://docs.npmjs.com/cli/v9/commands/npm-publish
Who do I Talk to? 🙋♀️
- Bryant Overgard
- Nathan Grant
- Travis Walters
- Chaz Mateer
Create React App (CRA) Boilerplate Below 🍽
Getting Started with Create React App
This project was bootstrapped with Create React App.
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 your browser.
The page will reload when you make changes.\ You may 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 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.
Code Splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
Analyzing the Bundle Size
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
Making a Progressive Web App
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
Advanced Configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
Deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
npm run build
fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
8 days ago
15 days ago
15 days ago
15 days ago
16 days ago
17 days ago
17 days ago
18 days ago
25 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
10 months ago
11 months ago
10 months ago
10 months ago
10 months ago
6 months ago
7 months ago
10 months ago
10 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
8 months ago
8 months ago
7 months ago
9 months ago
9 months ago
9 months ago
8 months ago
9 months ago
8 months ago
8 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
6 months ago
6 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago