Skip to content

CIROH-UA/ngiab-client

 
 

Repository files navigation

Next Gen in a Box Visualizer

This app was created using an experimental Tethys + React app scaffold. It uses React for the frontend of the app and Tethys as the backend.

Development Installation

You need to install both the Tethys dependencies and the node dependencies:

  1. Install the app in Tethys Platform
conda activate tethys
cd tethysapp-ngiab
tethys install -d
  1. Install the node and dependencies
cd tethysapp-ngiab
npm install --dev

Development

The webpack dev server is configured to proxy the Tethys development server (see webpack.config.js). The app endpoint will be handled by the webpack development server and all other endpoints will be handled by the Tethys (Django) development server. As such, you will need to start both in separate terminals.

  1. Start Tethys development server
tethys manage start
  1. Start webpack development server (in separate terminal)
npm start

Build

Webpack is configured to bundle and build the React app into the tethysapp/<app_package>/public/frontend directory. Before building a Python distribution for release, you should build using this command:

npm run build

Test

Use the following commands to lint and test the React portion of the app.

npm run lint
npm run test

The linting capability is powered by eslint and a number of plugins for React. The testing capabilities include jest, jsdom, testing-framework, user-event, and a few other JavaScript testing utilties to make it easy to test the frontend of the React-Tethys app.

Acknowledgements

This implementation is based on the excellent work done by @Jitensid that can be found on GitHub here: Jitensid/django-webpack-dev-server.

Some resources and source code is also derived from projects generated using Create React App.

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 76.7%
  • Python 17.5%
  • SCSS 3.1%
  • Dockerfile 1.0%
  • Shell 1.0%
  • HTML 0.5%
  • CSS 0.2%