The Aquarium Project Dashboard is a maintainable, easy to use, and extensible tool that enables an Aquarium user (researcher, lab manager) to track the progress of a project in an Aquarium instance, where a project is defined as a set of linked plans (complementary workflows) to be executed on given samples and may be linked to an experimental request. This tool will be integrated with Aquarium as possible. Different types of projects (e.g., protein design, strain construction) will utilize visualizations.
Although Aquarium has no internal representation of the expected project schedule, the dashboard will have such a representation and some ability of comparing expected and actual completion dates.
Currently, this version of Cuttlefish is being run with a React.js front-end and node.js backend, both being manually started on separate local servers. The Cuttlefish development backend is currently connecting to the BIOFAB production system at Aquarium, although it will soon be updated to work with a local Aquarium session.
-
From the terminal, clone this repository to your local machine
git clone https://github.com/klavinslab/project-dashboard.git
-
Within the local repository folder, install the necessary dependencies
npm install` or `yarn -
Within the same folder, start your local server
npm run start` or `yarn start -
Open your browser and navigate to
localhost:3000
-
In another terminal instance, navigate to the root of 'backend' folder
cd backend -
Within this directory, start the local node.js server using a specified Aquarium instance, including the Aquarium URL as the third command. For example, this command utilizes the main server, although you might be using a local instance of Aquarium, likely at 'http://localhost:3000/'
npm start "http://52.27.43.242/"
- React
- Material-UI
- Redux
- DraftJS
- ChartJS
- PrismJS
- React Markdown
- React Full Calendar
- Unzip the zip file that you have downloaded from Material-Ui. Inside the zip file, you will find the the source file (exactly this demo project) (react-material-kit-pro-x.x.x-.zip) and design folder where you will find two more folders for figma and sketch source files.
- Extract the contents of the zip file (react-material-kit-pro-x.x.x-.zip) into a folder that you will work within. For this documentation, we will refer that as "your work folder".
- Open your machine console application (Terminal, Command Prompt etc.), navigate into your work folder and run the following command and wait for it to finish:
npm install- After the installation is complete write in the terminal
npm run start- Open your browser and navigate to
localhost:3000