Google Summer of Code 2018 Project
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
config
dist
docs
src
static
test/unit
.babelrc
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.postcssrc.js
LICENSE
README.md
conf.json
index.html
package-lock.json
package.json
server.js

README.md

Cross InterMine Search Tool (GSoC'18)



Cross InterMine Search Tool

InterMine is a data warehouse system for biological research. There are around 30+ instances of InterMine all around the world. InterMines consist of huge datasets of biological and genetic data. Earlier, if a person wanted to search for a gene in multiple InterMines, he/she had no other choice than going to every InterMine portal and do the search. It was very difficult for a person to manage so many portals simultaneously and compare the results and filter them to get the required items. This whole process of searching and exploring InterMine data can be simplified by the use of Cross InterMine Search Tool.

For the project organization, please refer to https://github.com/intermine

Development

The project has been developed using Vue.js. It uses InterMine APIs under the hood. IM.js has been used for making HTTP requests to the InterMine API endpoints.

Dependencies

Check package.json for getting the list of all the npm dependencies.

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# run tests
npm run test

# build documentation
npm run build-docs

# start production server at localhost:5000 after build is done
npm start

Test Suite

An automated test suite has been setup for testing the application. The test suite uses Karma and Mocha for the testing stack. The test suite also generates a code coverage report which can be found at tests-coverage-report.

Documentation

Apart from the in-line comments in the code, documentation generated by JSDocs is available here.

Deployment

The application is ready to be deployed on Heroku. The project has been configured to run on a Node.js server. The dist/ folder contains the production build which is served by server.js.

Note: The project works best on Google Chrome. Use Google Chrome during development. Mozilla Firefox needs some additional CORS configuration in order to run the application in dev mode. Please deploy the application on InterMine server, otherwise, use a reverse proxy server to add CORS headers to HTTP requests in order to avoid CORS issues (especially on Firefox). CORS Anywhere can be used for this purpose.

Contact

You can contact the developers by opening an issue, or by email/chat.

Screenshots

Homepage


Tour Mode

InterMines Info

Search Results

Result Popup