APBS-Web: A New Interface for the APBS Web Server

This project was bootstrapped with Create React App. As such, this README will lift some of the content available from the original README, which can be found here

Table of Contents

• Overview
• Available Scripts
  • npm run dev
  • npm test
  • npm run build
• Build Container
  • docker build
• Reference Documentation

Overview

This project serves as the web interface for the APBS web server. The backend systems powering the interface and the main repository for this project lives in the APBS-REST repository.

Available Scripts

In the project directory, you can run:

npm run dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Prior to launching, a script is run to convert the environment variables from env/.env to variables used by the website.

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.

Build Container

If Docker is installed on your machine, you can build this web UI as a container image.

docker build

To build the image, run the following in the project directory:

docker build -t <TAG>

where <TAG> is the name you choose for the image.

Reference Documentation

• Ant Design - primary component library used in this project
• React Router - Declarative routing for React
• React Docs - Main documentation for ReactJS