{"id":28690822,"url":"https://github.com/synonymdev/bitcoin-map","last_synced_at":"2025-06-14T06:07:50.973Z","repository":{"id":280631098,"uuid":"941726178","full_name":"synonymdev/bitcoin-map","owner":"synonymdev","description":"A web application that displays Bitcoin-accepting locations worldwide on an interactive map.","archived":false,"fork":false,"pushed_at":"2025-03-12T19:31:40.000Z","size":33413,"stargazers_count":5,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-14T00:54:32.327Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://btcmap.synonym.to","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/synonymdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2025-03-02T23:59:20.000Z","updated_at":"2025-03-12T19:36:22.000Z","dependencies_parsed_at":"2025-03-04T13:39:58.237Z","dependency_job_id":"4a70ec86-76eb-4e89-855d-182dbbab8890","html_url":"https://github.com/synonymdev/bitcoin-map","commit_stats":null,"previous_names":["synonymdev/bitcoin-map"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/synonymdev/bitcoin-map","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fbitcoin-map","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fbitcoin-map/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fbitcoin-map/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fbitcoin-map/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/synonymdev","download_url":"https://codeload.github.com/synonymdev/bitcoin-map/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/synonymdev%2Fbitcoin-map/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259768622,"owners_count":22908232,"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":[],"created_at":"2025-06-14T06:07:50.408Z","updated_at":"2025-06-14T06:07:50.954Z","avatar_url":"https://github.com/synonymdev.png","language":"TypeScript","readme":"# 🗺️ Bitcoin Map\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Next.js](https://img.shields.io/badge/Next.js-14-black)](https://nextjs.org/) [![Node.js](https://img.shields.io/badge/Node.js-18.x-green)](https://nodejs.org/) [![Docker](https://img.shields.io/badge/Docker-Ready-blue)](#-running-with-docker-compose) [![Bitcoin](https://img.shields.io/badge/Bitcoin-Accepted-orange)](https://bitcoin.org/) [![Tests](https://github.com/synonymdev/bitcoin-map/actions/workflows/test.yml/badge.svg)](https://github.com/synonymdev/bitcoin-map/actions/workflows/test.yml)\n\nA web application that displays Bitcoin-accepting locations on an interactive map, making it easier for users to find and support businesses that accept Bitcoin.\n\n\u003cdiv align=\"center\"\u003e\n  \n  https://github.com/user-attachments/assets/db6d6971-6577-47c4-b9d8-a9e80b901a93\n  \n  *Quick demo of Bitcoin Map in action*\n\u003c/div\u003e\n\n## 🚀 Getting Started\n\nThis project consists of a Next.js frontend and Node.js Express backend. You can run the application using Docker Compose or in development mode.\n\n### 🐳 Running with Docker Compose\n\nThe easiest way to run the entire application in production mode is using Docker Compose:\n\n```bash\n# Clone the repository (if you haven't already)\ngit clone https://github.com/synonymdev/bitcoin-map.git\ncd bitcoin-map\n\n# Build and start the containers\ndocker-compose up --build -d\n\n# To stop the containers\ndocker-compose down\n```\n\nThe application will be available at:\n\n- 🌐 Frontend: http://localhost:3000\n- 🔌 Backend API: http://localhost:3001/api\n\n### 💻 Development Mode\n\nIf you want to run the application in development mode, follow these steps:\n\n#### 🔙 Backend\n\n```bash\n# Navigate to the backend directory\ncd backend\n\n# Install dependencies\nnpm install\n\n# Start the development server\nnpm run dev\n```\n\nThe backend server will run at http://localhost:3001.\n\n#### 🔜 Frontend\n\n```bash\n# Navigate to the frontend directory\ncd frontend\n\n# Install dependencies\nnpm install\n\n# Copy environment variables file\ncp .env-sample .env\n\n# Start the development server\nnpm run dev\n```\n\nThe frontend application will run at http://localhost:3000.\n\n## 📁 Project Structure\n\n- `frontend/`: Next.js frontend application\n- `backend/`: Node.js Express backend API\n- `docker-compose.yml`: Docker Compose configuration for running the entire application\n\n## 🔌 External APIs\n\nThe backend integrates with the following external services:\n\n- **[BTCMap.org](https://btcmap.org/api)**: Provides data on Bitcoin-accepting locations worldwide\n- **[Overpass API](https://overpass-api.de/)**: Used to fetch additional geographic and point-of-interest data from OpenStreetMap\n\nThese APIs are used to synchronize and maintain our database of Bitcoin-accepting locations.\n\n## ⏱️ Development Progress\n\n### 🎨 Frontend\n\n- [x] Interactive map display using Leaflet\n- [x] Marker clustering for improved performance\n- [x] Bitcoin location markers on the map\n- [x] Responsive design\n- [x] Location details popup\n- [x] Improved popup UI with better styling and organization\n- [x] Custom animations for loading states\n- [x] User location button for centering map on user's position\n- [x] Optimized data loading (coordinates first, details on demand)\n- [x] Number animations for statistics\n- [ ] Name-based search interface\n- [ ] Proximity search UI with radius selector\n- [ ] Country leaderboard UI\n- [ ] Direct links to OpenStreetMap for adding/editing locations\n- [ ] Documentation page\n- [ ] About page\n\n### ⚙️ Backend\n\n- [x] RESTful API for Bitcoin locations\n- [x] SQLite database integration\n- [x] Data synchronization system\n- [x] CORS configuration for frontend access\n- [x] Basic error handling\n- [x] Optimized API endpoints (coordinates-only and location details)\n- [x] Comprehensive test suite with Jest\n- [x] GitHub Actions workflows for testing and coverage\n- [ ] Name-based search API endpoint\n- [ ] Proximity search implementation using latitude and longitude\n- [ ] Country ranking data aggregation\n- [ ] API rate limiting implementation\n- [ ] API documentation\n\n### 🔧 DevOps\n\n- [x] Docker and Docker Compose setup\n- [x] GitHub Actions workflows for testing\n- [x] Test coverage reporting\n\n## 👥 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## 📄 License\n\nThis project is licensed under the [MIT LICENSE](LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynonymdev%2Fbitcoin-map","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsynonymdev%2Fbitcoin-map","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsynonymdev%2Fbitcoin-map/lists"}