Skip to content

Update README with screenshots and instructions #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Soriano-R merged 2 commits into from
Jun 30, 2025
Merged

Update README with screenshots and instructions #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e92f6c7
Fix numpy version to resolve dependency conflicts
Soriano-R Jun 30, 2025
029494f
Update README with screenshots and instructions
Soriano-R Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ This project implements an interactive web-based dashboard for exploring employe

The dashboard uses FastHTML for building HTML components directly in Python, and SQLite for persistent data storage.

## 🎥 Application Demo

[![Watch the Demo](https://img.shields.io/badge/Video-Demo-blue)](https://app.screencast.com/DGQPc0bQ2dgfC)

## 📸 Application Screenshots

### Home Page
![Dashboard Home](docs/dashboard_home.png)

### Employee Detail Page
![Employee Detail](docs/employee_detail.png)

## What Was Done

- **Database Creation**: Built a normalized SQLite database containing tables for employees, teams, events, and manager notes. Populated with synthetic data for demonstration.
Expand Down Expand Up @@ -99,10 +111,6 @@ cd dsnd-dashboard-project

You can then inspect their code and compare it with this implementation to see how different approaches to dashboarding are built.

## Authors

Developed as part of a data science capstone project.

## License

This project is licensed under the MIT License — see the LICENSE.txt file for details.
4 changes: 2 additions & 2 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
python-fasthtml==0.8.0
matplotlib==3.9.2
numpy==2.1.2
numpy==1.26.4
pandas==2.2.3
scikit-learn==1.3.2
scikit-learn==1.3.2
pytest
flake8
ipython
Expand Down