{"id":21835943,"url":"https://github.com/qingquan-li/us-data-demo","last_synced_at":"2025-04-14T09:19:56.964Z","repository":{"id":189443966,"uuid":"679982582","full_name":"qingquan-li/us-data-demo","owner":"qingquan-li","description":"CSV Data Visualization: visualize customer data stored in a CSV file, using React (frontend), Python/Flask (backend), Docker (deployment), and GitHub Actions (CI/CD).","archived":false,"fork":false,"pushed_at":"2023-08-31T22:39:54.000Z","size":575,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T09:19:50.447Z","etag":null,"topics":["data-visualization","docker","flask","react"],"latest_commit_sha":null,"homepage":"https://us-data-demo.qingquanli.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qingquan-li.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-18T04:25:51.000Z","updated_at":"2024-03-16T17:14:41.000Z","dependencies_parsed_at":"2024-11-27T20:40:07.829Z","dependency_job_id":null,"html_url":"https://github.com/qingquan-li/us-data-demo","commit_stats":null,"previous_names":["qingquan-li/us-data-demo"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qingquan-li%2Fus-data-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qingquan-li%2Fus-data-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qingquan-li%2Fus-data-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qingquan-li%2Fus-data-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qingquan-li","download_url":"https://codeload.github.com/qingquan-li/us-data-demo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248852186,"owners_count":21171843,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-visualization","docker","flask","react"],"created_at":"2024-11-27T20:26:31.034Z","updated_at":"2025-04-14T09:19:56.921Z","avatar_url":"https://github.com/qingquan-li.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# US Data Demo\n\n\u003cimg width=\"1552\" alt=\"US Data Demo Website Screenshot\" src=\"https://github.com/Qingquan-Li/us-data-demo/assets/19491358/bc823060-a43a-43c5-975c-48fbf159a0b5\"\u003e\n\n\n## 1. About the Project\n\nGiven: a dataset that contains the name, company, address and contact information of 500 people in the US (randomly generated).\nDataset: `us-500.csv` source from [Free Sample Data - BrianDunning.com](https://www.briandunning.com/sample-data/)\n\nTask:\n\n1. Create a web interface that retrieves and displays the dataset in the table.\n\n2. Search people based on two given inputs: search field and target value\n- For example, if the search field is state and the target value is NY, the result table should contain all people in the dataset who live in NY state.\n- If searched by first_name (e.g., Valentine) with a single result, display the user icon (user.png) with information about that person instead of the table.\n- If searched by company_name (e.g., Printing Dimensions) with a single result, display the video (example.mp4) along with other information like company name and address.\n\n3. Show summary statistics, such as the number of people per state\n\n4. Create a visualization to show the distribution of the people across the US, which can depend on the state or zip code.\n\n\n## 2. Tech Stack\n\n- Frontend:\n  - Language:\n    - JavaScript\n  - Frameworks/Libraries:\n    - React.js\n    - Tailwind CSS\n- Backend:\n  - Language:\n    - Python\n  - Frameworks/Libraries:\n    - Flask\n- Deployment:\n    - Docker on a Linux Server\n    - Nginx\n- CI/CD:\n    - GitHub Actions\n\n\n## 3. Run the Project\n\n1. Install Docker and Docker Compose\n\n2. Run the following commands:\n\n```bash\n# Go to the project directory:\n$ cd path/to/us-data-demo\n# Pull the latest images specified in docker-compose.prod.yml:\n$ docker-compose -f docker-compose.prod.yml pull\n# Run the containers with Docker Compose in detached mode:\n$ docker-compose -f docker-compose.prod.yml up -d\n```\n\n3. The project now is running on http://localhost:3000\n\n\n## 4. Build the Docker Images\n\n### 4.1 Build the Docker images locally (Development)\n\n```bash\n\n```bash\n# Go to the project directory:\n$ cd path/to/us-data-demo\n# Build the container without using cache:\n$ docker compose build --no-cache\n# Run the container in the background (detached mode):\n$ docker compose up -d\n# The project now is running on http://localhost:3000\n# Stop the container:\n$ docker compose down\n```\n\n### 4.2 Build the Docker Images with GitHub Actions (Production)\n\nDetails: check out `.github/workflows/docker_build.yml`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqingquan-li%2Fus-data-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqingquan-li%2Fus-data-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqingquan-li%2Fus-data-demo/lists"}