diff --git a/docs/bridge/README.md b/docs/bridge/README.md index afad5c80f5..73c43b2c0e 100644 --- a/docs/bridge/README.md +++ b/docs/bridge/README.md @@ -5,17 +5,18 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ## Generating API Docs + `yarn docusaurus gen-api-docs all`. ### Installation -``` +```bash $ yarn ``` ### Local Development -``` +```bash $ yarn start ``` @@ -23,8 +24,16 @@ This command starts a local development server and opens up a browser window. Mo ### Build -``` +```bash $ yarn build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. + +### Serve + +This step is needed to create a searchable index. + +```bash +$ yarn serve +``` diff --git a/packages/explorer-ui/README.md b/packages/explorer-ui/README.md index 76dc102563..31043416e4 100644 --- a/packages/explorer-ui/README.md +++ b/packages/explorer-ui/README.md @@ -1,59 +1,18 @@ # Explorer UI ## TODO: - - add readme describing explorer ui - - add integration tests -# Getting Started with Create React App +- add readme describing explorer ui +- add integration tests -This project was bootstrapped with [Create React App](https://github.com/facebook/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](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](https://facebook.github.io/create-react-app/docs/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](https://facebook.github.io/create-react-app/docs/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](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) +## To get started +run +```bash +yarn install +``` +```bash +yarn dev +``` diff --git a/packages/synapse-constants/package.json b/packages/synapse-constants/package.json index 0d9adc67f9..12b4aaa34e 100644 --- a/packages/synapse-constants/package.json +++ b/packages/synapse-constants/package.json @@ -27,6 +27,7 @@ "lint:check": "eslint . --max-warnings=0 --config .eslintrc.cjs", "prepare": "rollup -c --bundleConfigAsCjs", "build": "rollup -c --bundleConfigAsCjs", + "preinstall": "command -v rollup >/dev/null 2>&1 && rollup -c --buildConfigAsCjs || echo 'rollup not found'", "prepublish": "yarn build", "maps:generate": "node ./src/scripts/generateMaps.cjs && node ./src/scripts/findMissing.cjs && yarn build" },