The project is meant to be used as part of a Docker/Kubernetes container deployment. At present these container are not yet published and we invite you to look at the developer setup below.
First things first, there's always something before you can start.
To make our life easier, we use Yarn a lot. Make sure you have it installed.
This software requires both MongoDB and MinIO to be available. Follow the installation guidelines for these software directly from their respective websites:
Both software also have easy to start docker images available for convenience.
Building the library is easy. First run yarn install && yarn build, to build the application. The current application is built ontop of a system called ICL-ITMAT-Broker comprised of multiple components including :
- itmat-commons
- itmat-docker
- itmat-interface
- itmat-job-executor
- itmat-setup
- itmat-ui-react
You will need to provide database and object store connection details and will have the ability to customised other paramters. We typically recommend that you configure your secrets.
cp packages/itmat-interface/config/config.sample.json packages/itmat-interface/config/config.json
cp packages/itmat-job-executor/config/config.sample.json packages/itmat-job-executor/config/config.jsonThese config files need to be editted accordingly for Mongodb database (database{ }) and MinIO (objectStore{ }).
nodemailer{ } in packages/itmat-interface/config/config.json is also required to configure for email service.
yarn setupDatabaseOnce all that is done, you only need to use yarn start to start the software in development mode.
Big shout out goes to all the members of the Data Science Institute team at Imperial College London with special thanks to @sou-chon for laying the ground work this portal it built on.
Pull requests are welcome! See the list of open issues to get an idea of what you could work on. Or, if you have an awesome idea, please create a new issue.