Code Monkey home page Code Monkey logo

staphbook's Introduction

Staphbook

"A social network for genomes"

StaphBook is a web app that reads from a PostgreSQL database and displays Staphylococcus aureus genomes in an easy to read format. With this app users are able to:

  • browse genomes and view information such as isolation source and sequence data and be able to download the information as .csv files.
  • find similar genomes by shared information such as isolation sources and by genetic distance
  • favorite and tag samples by adding them to a group which can then be shared and viewed by other users
  • annotate groups and view generic statistics about each group

Prerequisites

  • Node.js v.10.15.3 (newer versions should be supported)
  • PostgresSQL v12.3 (newer versions should be supported)
  • Can run on Windows and MacOS

Installation Process

PostgreSQL Setup

  1. Download here: https://www.postgresql.org/download/
  2. Once installed, it is highly recommended that you use a GUI such as pgAdmin 4 which can be downloaded here: https://www.pgadmin.org/download/pgadmin-4-windows/
  3. Setup your PostgreSQL Server and run the database creation scripts in sql/.

Node.js Setup

  1. Download Node.js here: https://nodejs.org/en/download/
  2. Install Node.js

Run Project

  1. Clone project into your computer.
  2. Create an .env file using the provided template.env to contain the port configurations to your SQL server and host IP address of your application server.
  3. Run
npm install
node app.js

Extensions

Source code can be modified for other database schemas and genomes.

staphbook's People

Contributors

andrewgrant14029 avatar chaashya avatar maiscodes avatar sandrafinow avatar sazarc avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.