Skip to content

Latest commit

 

History

History
73 lines (39 loc) · 3.16 KB

README.md

File metadata and controls

73 lines (39 loc) · 3.16 KB

Knowledge Graph Front End

This project is an initial first working area for the Knowledge Graph Front-End.

This project relies upon React and NodeJS

Build with Docker

To build the project with Docker, use version 18.09 or higher as it uses BuildKit

From within this folder, run DOCKER_BUILDKIT=1 docker build --file Dockerfile --output build . to build the project.

Following the build, the static HTML files will be output in the front-end/build folder.

Setup

Before running the scripts with the project, you must first download the requirements listed in package.json.

Run npm install to set up the project.

Environment Variables

For development purposes it is possible to create a dotenv file, in the same top level folder as package.json.

Add the variable REACT_APP_API_PREFIX=https://example.com where example.com is the hostname of the api.

You can also use a conventional environment variable, or inject one into your Docker build like so:

DOCKER_BUILDKIT=1 docker build --env REACT_APP_API_PREFIX=https://example.com --file Dockerfile --output build .

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open 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 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!

The output of this folder, from within the 'build' folder itself, can be placed on the gh-pages branch to deploy to Github Pages.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests 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.

To learn React, check out the React documentation.