---

Flud: a game used for visualizing biological networks

Play online at http://flud.graphspace.org/

Installation Instructions

Here are steps you need to follow to get the system up and running

Prerequisites

1. Install Docker

Follow the instructions on Docker's website to install it.

2. Setup an account on GraphSpace

Flud interfaces with GraphSpace for storing and sharing networks and their layouts. Therefore, you need to create a GraphSpace account and a group to store all your Flud graphs and layouts.

1. Create an account (Instructions)
2. Go to this Groups page and create a group called "My flud group" (Instructions)

• Note down the Group ID from the group's URL. You will need this when we setup Flud.
  • If the groups URL is http://graphspace.org/groups/1234, then your Flud group's ID is 1234.

Setup instructions

1. Clone the repository to your computer

git clone https://github.com/Murali-group/Flud.git

2. Add GraphSpace account details to your development environment file

• Go to .env.dev file in Flud's root folder.
• Update these values with your GraphSpace username, password and Flud group ID.

GRAPHSPACE_USERNAME=XXXXXXXX
GRAPHSPACE_PASSWORD=XXXXXXXX
GRAPHSPACE_FLUD_GROUP_ID=XXXXXXXX

3. Start Flud server

This script builds the docker image and runs the container.

make compose_up

4. Prepare the database

This script adds an Anonymous user to the user table. This allows users to play Flud game without creating any account on Flud.

make prepare_db

5. Create demo games

This script add 3 demo graphs to your Flud group and creates a game for each of them.

make create_games

6. Play the game locally

Navigate to http://localhost:8000/ to again view the home screen.

Contributing

Feel free to fork and send us pull requests.

Contact

If you have questions or suggestions about Flud, please contact

• Aditya Bharadwaj (@adbharadwaj)
• Kurt Luther (@kluther)
• T.M. Murali (@tmmurali)

License

GraphSpace is available under the GNU General Public License v3.0 license. See LICENSE for more information.

Don't forget to cite us :)

https://dx.doi.org/10.1145/3479196