Skip to content

DynamicDevices/where-does-our-money-go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

34 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Where Does Our Money Go?

License: CC BY-NC-SA 4.0 Build Status TypeScript React Vite Tailwind CSS Chart.js Node.js GitHub Pages Educational Accessibility Mobile Friendly

A comprehensive educational website that explores how taxation is spent across different countries. This interactive platform helps users understand government spending, tax rates, and how public money is allocated.

🌐 Live Site

πŸš€ View Live Site | πŸ“Š Demo Data | πŸ“ˆ Historical Trends

🎯 What You Can Do:

  • Compare Countries: See how different nations tax and spend
  • Explore Historical Data: Track changes over time
  • Interactive Charts: Hover and click to explore data
  • Educational Content: Learn about taxation and government spending
  • Mobile Friendly: Works perfectly on all devices

πŸ“± Quick Start:

  1. Visit the live site above
  2. Select countries to compare
  3. Choose chart types (Bar, Line, Pie)
  4. Explore historical trends over time
  5. Read educational content in the About section

🌍 Features

  • Country Comparison: Compare tax rates and government spending between countries
  • Historical Data: Track how taxation and spending have changed over time
  • Interactive Visualizations: Charts and graphs to make data easy to understand
  • Educational Tooltips: Hover over categories to learn what different terms mean
  • Mobile Friendly: Works perfectly on desktop and mobile devices
  • School-Friendly: Designed to be accessible for students and educators

πŸ“Š Project Statistics

GitHub stars GitHub forks GitHub issues GitHub pull requests GitHub contributors GitHub last commit GitHub repo size GitHub language

πŸ“Š Data Sources

This website uses accurate, up-to-date data from:

  • OECD (Organisation for Economic Co-operation and Development)
  • World Bank
  • IMF (International Monetary Fund)
  • National statistical offices

πŸš€ Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/where-does-our-money-go.git
cd where-does-our-money-go
  1. Install dependencies:
npm install

Environment Setup

This application requires API keys for accessing official government data sources. Create a .env file in the root directory:

# API Keys for Data Sources
# Get these from the respective organizations:
# - OECD: https://stats.oecd.org/api/
# - World Bank: https://data.worldbank.org/developers
# - IMF: https://www.imf.org/en/data

VITE_OECD_API_KEY=your_oecd_api_key_here
VITE_WORLD_BANK_API_KEY=your_world_bank_api_key_here
VITE_IMF_API_KEY=your_imf_api_key_here
  1. Start the development server:
npm run dev
  1. Open your browser and visit http://localhost:3000

πŸ› οΈ Development

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run test - Run tests
  • npm run lint - Run linting
  • npm run preview - Preview production build

Project Structure

where-does-our-money-go/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/     # React components
β”‚   β”œβ”€β”€ data/          # Data files and API calls
β”‚   β”œβ”€β”€ hooks/         # Custom React hooks
β”‚   β”œβ”€β”€ pages/         # Page components
β”‚   β”œβ”€β”€ styles/        # CSS and styling
β”‚   └── utils/         # Utility functions
β”œβ”€β”€ public/            # Static assets
β”œβ”€β”€ tests/             # Test files
└── docs/              # Documentation

πŸ§ͺ Testing

The project includes comprehensive testing:

  • Unit tests for components and utilities
  • Integration tests for data flows
  • Visual regression tests for UI consistency

Test Coverage Code Quality Prettier TypeScript

Run tests with:

npm run test

πŸ“¦ Deployment

This project is automatically deployed to GitHub Pages when tests pass. The deployment process:

  1. Runs all tests
  2. Builds the production version
  3. Deploys to GitHub Pages if all tests pass

Deploy Status Live Demo Performance Bundle Size

πŸ” API Authentication Setup

1. Get API Keys

2. Local Development

Create a .env file with your API keys (see Environment Setup above).

3. GitHub Secrets (for deployment)

  1. Go to your GitHub repository
  2. Click Settings β†’ Secrets and variables β†’ Actions
  3. Click New repository secret
  4. Add these secrets:
    OECD_API_KEY=your_oecd_api_key_here
    WORLD_BANK_API_KEY=your_world_bank_api_key_here
    IMF_API_KEY=your_imf_api_key_here
    

4. Deployment

The GitHub Actions workflow will automatically use the secrets during deployment.

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

πŸ“„ License

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

  • All Content: CC BY-NC-SA 4.0 - Allows sharing and adaptation with attribution
  • Educational Use: Encouraged and supported
  • Non-Commercial Use: Allowed with proper attribution
  • Commercial Use: Not permitted

See the LICENSE file for full details.

πŸ™ Acknowledgments

  • Data provided by OECD, World Bank, and IMF
  • Built with React, TypeScript, and modern web technologies
  • Icons from Feather Icons
  • Charts powered by Chart.js

πŸ“ž Support

If you have questions or need help, please open an issue on GitHub or contact us at info@dynamicdevices.co.uk.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published