Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
add setup guide
  • Loading branch information
helingogo authored Mar 19, 2022
1 parent 69ee1cf commit ef2ec01
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,17 @@ You are welcome to contribute to olympic-dash if you have any idea regarding to

### How to install and run locally

To run the dashboard locally, we recommend to use a virtual environment like [venv](https://docs.python.org/3/library/venv.html) or [Anaconda](https://www.anaconda.com/). For simplicity, we could demonstrate the installiation process with venv.
Run the following command at the root directory of the project:

#### Setup
1. Copy and paste the following link: git clone https://github.com/UBC-MDS/olympic-dash-R.git to your Terminal.

Run the following command at the root directory of the project:
2. On your terminal, type: cd olympic-dash-R.

3. To run an app instance locally, first install the dependencies by typing: Rscript init.R

4. Launch app.R by typing: Rscript app.R

5. Using any modern web browser, visit http://127.0.0.1:8050/ to access the app.


## Contributors
Expand Down

0 comments on commit ef2ec01

Please sign in to comment.