Skip to content

Commit

Permalink
Merge pull request #29 from UBC-MDS/docs-update-readme
Browse files Browse the repository at this point in the history
Docs update readme
  • Loading branch information
Anupriya-Sri authored Mar 5, 2022
2 parents 7bc7985 + da86cfd commit 261e480
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Gapminder dashboard

![app_usage](https://user-images.githubusercontent.com/88474134/156894591-9d7a9b26-01a1-4a10-b6b5-a4979539040f.gif)


## Decription of the app

The Gapminder dataset is a great source of information to learn about the world. The main objective of this app is to investigate what the young population of students know and don’t know about basic global patterns and macro-trends and educate the intended users on global development trends. This dashboard has been developed to communicate insights about historical social/economic trends and create a better understanding of using and teaching statistics.
Expand All @@ -9,6 +12,11 @@ Additionally we include a bubble chart which visualizes the target study versus

The global map is presented at the bottom of the dashboard with a tooltip for each country. After choosing a continent in the filter section, the selected continent should be highlighted and the colour gradient will dictate the values of the target of study within that region. To the right of the global map, a bar plot will show the top ten countries with highest value for the selected target of study.

## Useful link
- 📊 [Dashboard Link](https://dsci532-2022-gapminder-app.herokuapp.com/)
- 🗺 [Gapminder website](https://www.gapminder.org/)


## Dashboard Sketch Design

![sketch of the app](img/app_sketch.png "App Sketch")
Expand All @@ -32,6 +40,11 @@ To run the application locally run the following command and navigate to [http:/
```bash
python src/app.py
```
## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

For this project, we used `Dash` for dashboarding, `Altair` for charts, and `Heroku` for deployment. Please follow the `Usage and Installation` to install and run the app locally.

## Contributors

Expand Down

0 comments on commit 261e480

Please sign in to comment.