Skip to content

Commit 8a3fc8a

Browse files
author
Ashwath Krishnan
committed
feat: Added README.md and CONTRIBUTING.md
1 parent efa0fdc commit 8a3fc8a

File tree

3 files changed

+114
-1
lines changed

3 files changed

+114
-1
lines changed

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing to PCHA Dashboard
2+
3+
Thank you for your interest in contributing to the **PCHA Dashboard**, a PyShiny-based accessible health data visualization tool.
4+
5+
---
6+
7+
## How to Contribute
8+
9+
### 1. Fork and Clone
10+
11+
```bash
12+
git clone https://github.com/[your-username]/pcha-dashboard.git
13+
cd pcha-dashboard
14+
```
15+
16+
### 2. Set Up Environment
17+
18+
```bash
19+
python -m venv venv
20+
source venv/bin/activate # On Windows: venv\Scripts\activate
21+
pip install -r requirements.txt
22+
```
23+
24+
### 3. Run the App Locally
25+
26+
```bash
27+
shiny run --reload app.py
28+
```
29+
30+
---
31+
32+
## Guidelines
33+
34+
- Follow PEP8 and Python best practices
35+
- Use `maidr` for all key data visualizations to ensure accessibility
36+
- Clearly label all charts and filters
37+
- Use semantic HTML where applicable for screen reader compatibility
38+
39+
---
40+
41+
## Accessibility Standards
42+
43+
We aim to provide full access to users who are blind or have low vision. Please:
44+
45+
- Ensure graphs are compatible with `maidr`
46+
- Include alt-text or captions where possible
47+
- Avoid relying solely on visual cues (e.g., color-only distinctions)
48+
49+
---
50+
51+
## Deployment
52+
53+
Deployment is handled through [shinyapps.io](https://www.shinyapps.io/). If you are a maintainer:
54+
55+
1. Ensure the app runs correctly locally
56+
2. Deploy using `rsconnect` with Python support or push updates to the hosting environment
57+
58+
---
59+
60+
## Reporting Issues
61+
62+
If you find a bug or have a feature request, open an issue at:
63+
[https://github.com/xabilitylab/pcha-dashboard/issues](https://github.com/xabilitylab/pcha-dashboard/issues)
64+
65+
Thank you for helping make this dashboard better and more inclusive.
2.97 KB
Binary file not shown.

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1-
## PCHA Dashboard app
1+
# PCHA Dashboard
22

3+
The **PCHA Dashboard** is a PyShiny-based web application for visualizing user health data collected through the PCHA app. This tool extends the functionality of the mobile application by providing accessible visual analytics, including step count, calories burned, and distance walked over time.
4+
5+
## Live App
6+
7+
The dashboard is hosted at:
8+
[https://xabilitylab.shinyapps.io/pcha-dashboard/](https://xabilitylab.shinyapps.io/pcha-dashboard/)
9+
10+
## Features
11+
12+
- Interactive visualization of health metrics
13+
- Date-based filtering for time-series analysis
14+
- Designed with accessibility in mind using the `maidr` visualization library for blind and low vision users
15+
- Responsive and accessible interface using PyShiny
16+
17+
## Technologies Used
18+
19+
- [PyShiny](https://shiny.posit.co/py/)
20+
- `maidr` (for accessible graphs)
21+
- Python, Plotly, and Pandas
22+
23+
## Getting Started
24+
25+
### Prerequisites
26+
27+
- Python 3.8+
28+
- Packages: `shiny`, `maidr`, `pandas`, `plotly`, `datetime`, `numpy`
29+
30+
### Run Locally
31+
32+
```bash
33+
# Create a virtual environment
34+
python -m venv venv
35+
source venv/bin/activate # On Windows: venv\Scripts\activate
36+
37+
# Install dependencies
38+
pip install -r requirements.txt
39+
40+
# Run the app
41+
shiny run --reload app.py
42+
```
43+
44+
## Contributing
45+
46+
We welcome improvements in UI, accessibility, or visualization logic. Please see the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more details.
47+
48+
## License
49+
50+
MIT License

0 commit comments

Comments
 (0)