Skip to content

Commit

Permalink
add installation form git, docker is missing
Browse files Browse the repository at this point in the history
  • Loading branch information
LeaSeep committed Jul 4, 2024
1 parent 6ada66c commit edbc2de
Showing 1 changed file with 98 additions and 7 deletions.
105 changes: 98 additions & 7 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,117 @@
layout: default
title: "Local Installation"
nav_order: 5
editor_options:
markdown:
wrap: 72
---

# Introduction
![A comic about a cat finding cOmicsART](/OmicShiny/assets/images/cOmicsTurtle.png)
*Image generated using DALL-E by OpenAI. Adjusted by Lea Seep*

Why do you want to install cOmicsART locally? If you just want to use it make sure to checkout the website: [cOmicsART](https://comicsart.org/). For this there is no installation effort required.
If you know you are right here, let's get started.
![A comic about a cat finding
cOmicsART](/OmicShiny/assets/images/cOmicsTurtle.png) *Image generated
using DALL-E by OpenAI. Adjusted by Lea Seep*

Why do you want to install cOmicsART locally? If you just want to use it
make sure to checkout the website:
[cOmicsART](https://shiny.iaas.uni-bonn.de/OmicShiny/). For this there
is no installation effort required. If you know you are right here,
let's get started.

# Running a cOmicsART locally within RStudio

# Installing and Running the Shiny App Locally

This guide provides detailed instructions on how to install and run the
Shiny app from the provided GitHub repository.

## Prerequisites

Ensure you have the following software installed on your system: -
[Git](https://git-scm.com/) - [R](https://www.r-project.org/) -
[RStudio](https://rstudio.com/products/rstudio/download/) -
[renv](https://rstudio.github.io/renv/articles/renv.html) package in R

## Steps to Install and Run the Shiny App

### 1. Clone the GitHub Repository

Open a terminal or command prompt and use the following command to clone
the repository:

``` bash
git clone https://github.com/leaseep/OmicShiny.git
```

### 2. Navigate to the Project Directory

Change the directory to the cloned repository:

``` bash
cd OmicShiny
```

## 3. Restore the R Environment

The project uses renv to manage dependencies. Restore the required R
packages using the renv.lock file. Open R or RStudio. Ensure the package
`renv` is installed in your R environment.Test with

``` r
library(renv)
```

If you get an error, install it using the following command:

``` r
install.packages("renv")
```

Then set the working directory to the root directory to install the
environment from the lock file:

``` r
renv::restore(lockfile="renv.lock")
```

This will install all the necessary packages as specified in the
renv.lock file. **Note:** This takes quite some time as there are a lot of packages to retrieve.
Some of those need specific system dependencies.

## 4. Start the Shiny App

From the R console, start the Shiny app using the following command.
Note that you will need to be in the `program` directory.

``` r
shiny::runApp('shinyApp',port=3939)
```

After starting the Shiny app, you will see an IP address printed in the
R console:

``` r
Listening on http://127.0.0.1:3939
```

Open your web browser and go to the provided IP address to access the
Shiny app.

# Running a cOmicsART Using Docker

This guide will help you use the provided Docker image to start your Shiny app.
This guide will help you use the provided Docker image to start your
Shiny app.

## Prerequisites

1. **Install Docker**: Ensure Docker is installed on your system. You can download and install Docker from [Docker's official website](https://www.docker.com/get-started).
1. **Install Docker**: Ensure Docker is installed on your system. You
can download and install Docker from [Docker's official
website](https://www.docker.com/get-started).

## Steps to Run the ShinyApp

.....

# Local deploy the App from github

....
....

0 comments on commit edbc2de

Please sign in to comment.