Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nizar-masmoudi committed Apr 28, 2023
1 parent a9b9189 commit dcc2333
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# CryptoDash

-- insert description here --
## Introduction

This dashboard is a web application built with Python, Dash and Plotly. It allows users to track cryptocurrency coins and markets.

## Installation

1. Clone this repository to your local machine
```
> git clone https://github.com/nizar-masmoudi/cryptodash.git
```
2. Install the required dependencies
```
> pip install -r requirements.txt
```

## Usage
To run the dashboard, use the following command:
```
> python app.py
```
This will start the application and it will be accessible at http://localhost:8050. If you want to run the application on debug mode, add `--debug` flag to the command.

## Project structure
```
.
├── .github/workflows
├── api
├── assets
├── components
├── app.py
├── requirements.txt
├── Spacefile
├── .gitignore
└── .env.template
```

## Deployment

0 comments on commit dcc2333

Please sign in to comment.