react-college-search
This is the react organism for Scoir college-search!
Development
Node Versioning
This repo runs on Node.js -- An .nvmrc
file is included to allow for automatic Node.js versioning.
Run nvm use
to use the version of Node.js specified in the .nvmrc
file.
To set up automatic Node.js versioning on your machine:
- Follow these steps: https://stackoverflow.com/questions/23556330/run-nvm-use-automatically-every-time-theres-a-nvmrc-file-on-the-directory
- You should see a message in your terminal when you cd into a directory with
.nvmrc
, either notifying you that you are using the correct version for the project or that you need to install it.
1. Install dependencies
npm i
2. Run Storybook
Navigate to /stories and run
npm run storybook
Note* If you make a change in the package, you will need to rebuild the package to see the changes.
3. Linking
If you are working on a local version of the package and want to see it in a *-web app, you can link this package to your web app.
-
In this package directory, run the following
npm install
npm run build
npm link
-
In your web app directory, run the following
npm install
npm link @scoir/react-college-search
npm start
Note* If you make a change in the package, you will need to rebuild the package to see the changes.
You may need to run rm -rf node_modules/.cache
and restart your web app directory to clear the cache and see the changes.