Code Monkey home page Code Monkey logo

gooddoc's Introduction

GoodDoc -- A Template for Simple and Clear Documentation of Bioinformatics Code!

Please cite our work -- here is the ICMJE Standard Citation:

...and a link to the DOI:

Awesome Logo

You can make a free DOI with zenodo

Website (if applicable)

Intro statement

What's the problem?

Why should we solve it?

What is ?

Overview Diagram

How to use

Installation options:

We provide two options for installing : Docker or directly from Github.

Docker

The Docker image contains as well as a webserver and FTP server in case you want to deploy the FTP server. It does also contain a web server for testing the main website (but should only be used for debug purposes).

  1. docker pull ncbihackathons/<this software> command to pull the image from the DockerHub
  2. docker run ncbihackathons/<this software> Run the docker image from the master shell script
  3. Edit the configuration files as below

Installing from Github

  1. git clone https://github.com/NCBI-Hackathons/<this software>.git
  2. Edit the configuration files as below
  3. sh server/<this software>.sh to test
  4. Add cron job as required (to execute .sh script)

Configuration

Examples here

Testing

We tested four different tools with . They can be found in server/tools/ .

Additional Functionality

DockerFile

comes with a Dockerfile which can be used to build the Docker image.

  1. git clone https://github.com/NCBI-Hackathons/<this software>.git
  2. cd server
  3. docker build --rm -t <this software>/<this software> .
  4. docker run -t -i <this software>/<this software>

Website

There is also a Docker image for hosting the main website. This should only be used for debug purposes.

  1. git clone https://github.com/NCBI-Hackathons/<this software>.git
  2. cd Website
  3. docker build --rm -t <this software>/website .
  4. docker run -t -i <this software>/website

gooddoc's People

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.