harmonydata / app

Harmony front end

Home Page:https://harmonydata.ac.uk/app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Harmony Project logo

🌐 harmonydata.ac.uk Harmony | LinkedIn Harmony | X Harmony | Instagram Harmony | Facebook Harmony | YouTube

Harmony Front End

my badge License forks

This is the app in React which is running at https://harmonydata.ac.uk/app. It is not the blog which is at the base of the https://harmonydata.ac.uk domain at all paths other than /app.

Installing on your local machine

YouTube video on installing and running the app in Windows

How to run Harmony's Node.js front end.

First you need the API server running. Download, install and start the Harmony API. The Node.js front end will connect to the API server.

Follow the steps to install Node.js.

Then cd into this cloned folder (cd app) and run:

npm install
npm start

You can access Harmony in your browser at http://localhost:3000/app#/.

screenshot

How to run this front end and connect to localhost API

Watch a video tutorial on how to run the Harmony front end locally and connect to Harmony API on localhost

Run the Harmony API app in Python.

Open .env and change REACT_APP_API_URL to http://localhost:8000 and change REACT_APP_ABSOLUTE_URL_PREFIX to http://localhost:8000/app (so that the front end knows that it's running on localhost and that it should connect to a localhost API)

REACT_APP_API_URL=http://localhost:8000
REACT_APP_ABSOLUTE_URL_PREFIX=http://localhost:8000/app

Then run npm install; npm start as usual.

Who to contact?

You can contact Harmony team at https://harmonydata.ac.uk/, Thomas Wood at http://fastdatascience.com/ or John Rogers at http://delosis.com

Deployment

Commits / pull requests to the master or staging branches will trigger an automatic build on netlifiy - temporay build URLS will be displayed in pull requests and please manually confirm your commits are working as intended.

The staging branch is always available at https://harmony-staging.netlify.app/

This app is deployed to the main website using Github actions when there is a push to releases branch - this is a protected branch. The script to do this is under folder .github.

Ulster University is managing the domain harmonydata.ac.uk which is configured to point to the IPs of the Github Pages deployment.

How to contribute

You can raise an issue in the issue tracker, and you can open a pull request.

Please contact us at https://harmonydata.ac.uk/contact or write to thomas@fastdatascience.com if you would like to be involved in the project.

About

Harmony front end

https://harmonydata.ac.uk/app/

License:MIT License


Languages

Language:JavaScript 94.4%Language:HTML 2.9%Language:TypeScript 2.1%Language:CSS 0.6%