https://github.com/mskcc/voyager-operation-dashboard

Dashboard to facilitate voyager operations
https://github.com/mskcc/voyager-operation-dashboard

Last synced: about 2 months ago
JSON representation

Dashboard to facilitate voyager operations

• Host: GitHub
• URL: https://github.com/mskcc/voyager-operation-dashboard
• Owner: mskcc
• Created: 2022-09-08T19:09:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-10T18:59:25.000Z (over 1 year ago)
• Last Synced: 2023-08-11T00:49:12.157Z (over 1 year ago)
• Language: JavaScript
• Size: 1.5 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Voyager-Operation-Dashboard

Dashboard to facilitate voyager operations. This application was developed using a [React framework](https://reactjs.org/) front-end and [Python Django](https://www.djangoproject.com/) back-end.

## Prerequisites

### Setting up beagle

1. Run the Docker image:

```

docker run -it -p 8081:8081 mskcc/beagle:latest

```

2. The beagle swagger page is now running on your local computer

```

http://localhost:8081/

```

### Setting up the Application

1. Clone the repository: `git clone https://github.com/mskcc/Voyager-Operation-Dashboard.git`

2. Navigate to the project directory: `cd Voyager-Operation-Dashboard`

#### Setting up the Python Django Back-End

1. From the project directory, navigate to the Django back-end in the command line: `cd server/voyager_server`

2. Create a virtual env if none exists with `python -m venv venv`

3. Source the venv: `source venv/bin/activate`

4. Install all the required Python packages using pip: `pip install -r requirements.txt`

5. Create database migrations based on the models in the server that will be synchronized with the PostgreSQL database at step 4 below: `python manage.py makemigrations`

6. Synchronize the PostgreSQL database with the models and migrations from step 3: `python manage.py migrate`

7. Install static files needed for the admin page: `python3 manage.py collectstatic`

8. Run the development server on port 8000: `python manage.py runserver`

9. Navigate to the API endpoint: http://127.0.0.1:8000/api/jobs/

#### Setting up the React Front-End

1. From the project directory, navigate to the React front-end in the command line: `cd voyager-operation-dashboard`

2. Install node packages: `npm install`

3. Runs the application in development mode: `npm start`