Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.78 KB

README.md

File metadata and controls

35 lines (22 loc) · 1.78 KB

License: MIT

Softpack Web

Softpack Web provides the graphical user interface, designed using the Tokyo React Template, for those services which are provided by softpack: multi-user software environment sharing, management and creation!

Installation

Starting the React App

At the time of writing - whilst this app is still undergoing development - this app must be started through three commands, which are to be ran from inside the directory of the cloned version of this repository.

  1. git checkout develop - this makes sure you are in the correct branch.
  2. npm install - this will install all the necessary packages and dependencies for Softpack Web.
  3. npm run dev - this will compile and start the app (in development mode).

If the core is running on a port other than the default (8000), configure this by setting the environment variable $VITE_CORE_PORT. You can do this persistently by creating a file called .env.local with the contents VITE_CORE_PORT=1234, for example. See the Vite documentation for details.

Starting the server

Then, once the above steps are complete, the user must also start the server - SoftPack Core - this is what the React App will communicate with. This is done by,

  1. Git clone https://github.com/wtsi-hgi/softpack-core.git
  2. poetry install - this will install all the necessary packages and dependencies for Softpack Core.
  3. softpack-core service run - this will compile and start the server.

Using the app

Once complete, you should be able to use the app and explore the range of features which Softpack Web has to offer!