Merge pull request #2 from UBC-MDS/copy-files

Add necessary files from Python app repo

CONDUCT.md

@@ -0,0 +1,50 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Contact
+The project team can be contacted at any of the following:
+  * imtvwy@gmail.com
+  * soncqb@gmail.com
+  * irene93@student.ubc.ca
+  * junigord@gmail.com
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant homepage](http://contributor-covenant.org/version/1/4), version 1.4.

CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+## Types of Contributions
+
+### Report Bugs
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+You can never have enough documentation! Please feel free to contribute to any
+part of the documentation, such as the official docs, docstrings, or even 
+on the web in blog posts, articles, and such.
+
+### Submit Feedback
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `dsci532_group12` for local development.
+
+1. Download a copy of `dsci532_group12` locally.
+2. Install `dsci532_group12` using `poetry`:
+
+    ```console
+    $ poetry install
+    ```
+
+3. Use `git` (or similar) to create a branch for local development and make your changes:
+
+    ```console
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+4. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.
+
+5. Commit your changes and open a pull request.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include additional tests if appropriate.
+2. If the pull request adds functionality, the docs should be updated.
+3. The pull request should work for all currently supported operating systems and versions of Python.
+
+## Code of Conduct
+
+Please note that the `dsci532_group12` project is released with a 
+[Code of Conduct](https://github.com/UBC-MDS/gapminder_challenge-R/blob/main/CONDUCT.md). By contributing to this project you agree to abide by its terms.

README.md

@@ -1 +1,74 @@
-# gapminder_challenge-R
+# Gapminder Challenge R App
+
+Link to the app: TODO
+
+![](images/gapminder_animation.gif)
+
+## Welcome!
+
+Thank you for visiting the Gapminder Challenge R app project repository.
+
+This document is aimed to give you some information about our project. You can either jump straight to one of the sections below or scroll down to find out more.
+
+* [About this project](#about-this-project)
+* [Installation](#installation)
+* [Get Involved](#get-involved)
+* [License and Contributors](#license-and-contributors)
+
+## About this project
+
+### The App
+
+Our app is hosted on Heroku. Take the challenges [here](TODO) to see how you understand global issues. You will be able to:
+
+* know immediately if your worldview is up-to-date
+
+* see visual plots of the underlying data
+
+* interact with the app by filtering year range, region, and more
+
+Test yourselves now!
+
+### Project Motivation
+
+This project is designed to augment the existing gapminder [worldview upgrader](https://upgrader.gapminder.org/) tool. [Gapminder](https://www.gapminder.org/) is an NGO founded to address systematic misconceptions about global development. Gapminder provides free-to-access data and teaching material on global development based on reliable statistics. Their worldview upgrader involves participants answering questions about various topics linked to [UN development goals](https://sdgs.un.org/goals), and being provided correct answers with accompanying explanations. Our project proposes to augment the experience of the worldview upgrader by providing interactive visualizations along with answers to questions related to UN development goals, leveraging the [Gapminder dataset](https://cran.r-project.org/web/packages/gapminder/README.html). This allows our users to explore and manipulate the data supporting the answers to the questions, providing a dynamic and enriched learning experience.
+
+### Dashboard Description
+
+Our app features a single page that hosts four interactive data visualization plots by a 2 by 2 layout. Each plot is associated with one question that evaluates the users' understanding of global development since 1900s. The topics include child birth rate, child mortality vs. income level, average life expectancy, and income per capita. Each plot has its own controls, such as sliders for year range and drop-down menus for country, region, and income group selections. These components allow the users to explore and manipulate the data supporting the answers to the questions, offering a dynamic and enriched learning experience.
+
+Here is an example sketch of the app:
+
+![](images/app_sketch.png)
+
+## Installation
+
+TODO
+
+## Get Involved
+
+Our app is still under active development. We'd love your feedback along the way.
+
+Interested in contributing? We can certainly use your expertise in user experience design, data validation, front end development, and documentation. 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` and `Plotly` for charts, and `Heroku` for deployment. Do check out the following links to learn more about them:
+
+* [Dash Python User Guide](https://dash.plotly.com/)
+* [Dash interactive visualization](https://dash.plotly.com/interactive-graphing)
+* [Altair documentation](https://altair-viz.github.io/index.html)
+* [Plotly Python documentation](https://plotly.com/python/)
+* [Deploying Dash (on Heroku)](https://dash.plotly.com/deployment)
+
+## License and Contributors
+
+`gapminder_challenge` was created by:
+
+* Son Chau
+
+* Julien Gordon
+
+* Irene Yan
+
+* Vanessa Yuen
+
+It is licensed under the terms of the MIT license.