Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amand1996/cross-intermine-search-tool
Google Summer of Code 2018 Project
https://github.com/amand1996/cross-intermine-search-tool
gsoc intermine search
Last synced: about 2 months ago
JSON representation
Google Summer of Code 2018 Project
- Host: GitHub
- URL: https://github.com/amand1996/cross-intermine-search-tool
- Owner: amand1996
- License: other
- Created: 2018-04-28T21:07:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-27T18:09:28.000Z (about 6 years ago)
- Last Synced: 2024-02-13T20:41:36.427Z (11 months ago)
- Topics: gsoc, intermine, search
- Language: Vue
- Homepage:
- Size: 2.99 MB
- Stars: 2
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cross InterMine Search Tool (GSoC'18)
[Cross InterMine Search Tool](http://cross-intermine-search-tool.herokuapp.com/)
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](https://vuejs.org). It uses InterMine APIs under the hood.
[IM.js](https://github.com/intermine/imjs) 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
``` bash
# 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](https://cross-intermine-search-tool.herokuapp.com/test-report).
## Documentation
Apart from the in-line comments in the code, documentation generated by JSDocs is available [here](https://cross-intermine-search-tool.herokuapp.com/docs).
## 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](https://github.com/Rob--W/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
