An open API service indexing awesome lists of open source software.

https://github.com/hairyduck/policestopsearch.co.uk

An open source web application for exploring and analyzing UK police stop and search data. Built with Vue 3, Nuxt 3, and TypeScript.
https://github.com/hairyduck/policestopsearch.co.uk

Last synced: 4 months ago
JSON representation

An open source web application for exploring and analyzing UK police stop and search data. Built with Vue 3, Nuxt 3, and TypeScript.

Awesome Lists containing this project

README

        

# UK Police Stop and Search Data Portal 🚔

An interactive platform for exploring and analyzing UK police stop and search data. This project aims to make police data more accessible and transparent through intuitive visualization tools and detailed analytics.

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Built with Nuxt](https://img.shields.io/badge/Built%20with-Nuxt-00DC82.svg)](https://nuxt.com/)
[![Data Source](https://img.shields.io/badge/Data%20Source-UK%20Police%20API-yellow.svg)](https://data.police.uk/)
[![Deployed with FTP Deploy Action](https://img.shields.io/badge/Deployed%20with-FTP%20Deploy%20Action-2b9348)](https://github.com/SamKirkland/FTP-Deploy-Action)
[![TailwindCSS](https://img.shields.io/badge/Tailwind%20CSS-38B2AC?logo=tailwind-css&logoColor=white)](https://tailwindcss.com)
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![Pinia](https://img.shields.io/badge/Pinia-35495E?logo=vue.js&logoColor=4FC08D)](https://pinia.vuejs.org/)
[![Chart.js](https://img.shields.io/badge/Chart.js-FF6384?logo=chart.js&logoColor=white)](https://www.chartjs.org/)

## 🌟 Features

- **Interactive Map**: Visualize stop and search incidents across the UK with filtering capabilities
- **Detailed Statistics**: Comprehensive analytics and trends for each police force
- **Force Comparison**: Compare statistics across different police forces
- **Mobile Responsive**: Full functionality on all devices
- **Real-time Data**: Updated monthly with the latest available police data
- **Performance Optimized**: Fast loading with data caching and lazy loading

## 🚀 Quick Start

### Prerequisites

- Node.js (v18 or later)
- npm or yarn

### Installation

1. Clone the repository:
```bash
git clone https://github.com/HairyDuck/PoliceStopSearch.co.uk.git
cd PoliceStopSearch.co.uk
```

2. Install dependencies:
```bash
npm install
```

3. Start the development server:
```bash
npm run dev
```

4. Build for production:
```bash
npm run build
```

## 🛠️ Tech Stack

- **Framework**: [Nuxt 3](https://nuxt.com/) - Vue.js Framework
- **Styling**: [Tailwind CSS](https://tailwindcss.com/) - Utility-first CSS framework
- **Maps**: [Leaflet](https://leafletjs.com/) - Interactive maps
- **Charts**: [Chart.js](https://www.chartjs.org/) - Data visualization
- **State Management**: [Pinia](https://pinia.vuejs.org/) - Vue Store
- **Data Source**: [UK Police API](https://data.police.uk/docs/) - Official UK Police Data

## 📊 Data Sources

All data is sourced from the official UK Police Data API. The data is typically updated monthly with a two-month delay (e.g., January data becomes available in March).

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to:

- Report bugs
- Suggest new features
- Submit pull requests
- Set up your development environment

## 📝 Documentation

- [API Documentation](https://data.police.uk/docs/)
- [Frequently Asked Questions](https://policestopsearch.co.uk/faq)
- [Privacy Policy](https://policestopsearch.co.uk/privacy)
- [Terms of Service](https://policestopsearch.co.uk/terms)

## 🔒 Security

- HTTPS enforced for all connections
- No personal data collection
- Data sourced only from official police API
- Regular security updates

## 📈 Performance

- Optimized asset loading
- Efficient data caching
- Lazy loading of components
- Mobile-first responsive design

## 🌐 Browser Support

- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)
- Mobile browsers

## 📱 Mobile Apps

While we don't currently have native mobile apps, our website is fully responsive and works great on mobile devices. You can add it to your home screen for an app-like experience.

## 🔄 Updates

The platform is regularly updated with:
- Latest stop and search data (monthly)
- New features and improvements
- Security patches
- Performance optimizations

## 📫 Contact

- Email: [email protected]
- GitHub Issues: For bug reports and feature requests

## ⚖️ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgments

- [UK Police Forces](https://www.police.uk/) for providing the data
- All our [contributors](https://github.com/HairyDuck/PoliceStopSearch.co.uk/graphs/contributors)
- The open-source community

---

Made with ❤️ for transparency in UK policing