RCSB Documentation Module (@rcsb/rcsb-documentation)

This project is a React application that has been configured with Webpack for building and development.

The RCSB Documentation Module is a React-based project designed to serve as a dynamic and user-friendly landing page for hosting documentation related to RCSB.org. This module is intended to be integrated within the RCSB Sierra web application, providing an enhanced user experience and streamlining access to information pertinent to the features and data available on RCSB.org.

Installation

You can install the RCSB Documentation Module via npm:

npm install @rcsb/rcsb-documentation

Available Scripts

Inside the project directory, you can run the following commands:

npm start

• Launches the development server with Webpack.
• Open http://localhost:3000 to view the app in your browser.
• The app supports hot reloading, so any changes to the source files will automatically reflect in the browser.

npm run build

• Builds the project for production.
• Creates an optimized build in the build folder.
• The output is minified, and the filenames include content hashes for cache busting.

Project Structure

• src/: Contains the source code of the application, including components, styles, and assets.
• build/: The production-ready output generated by Webpack after running npm run build.
• webpack.config.js: The Webpack configuration file that manages the build and bundling process.
• .babelrc: Babel configuration file for JavaScript transpilation.

Publish

Prerelease

npm version prerelease # assumes the current version ends with '-dev.X'
npm publish --tag next

Release

npm version 0.X.0 # provide valid semver string
npm publish

License

This project is licensed under the MIT License.