geofirestore-core

Full documentation is available at https://core.geofirestore.com

Lightweight location-based querying and encoding of Firebase Firestore Documents for geofirestore.

🤝 Contributing

We welcome contributions! Please follow our CONTRIBUTING.md guidelines.

Commit Messages (Conventional Commits)

We use the Conventional Commits standard for commit messages. This helps us generate changelogs automatically and keep project history clear.

Example:

feat(geofirestore-core): add support for custom query filters

Note: When your commit affects a specific package, use the package name as the scope (e.g., geofirestore or geofirestore-core).

See the root CONTRIBUTING.md for full details and allowed types.

Development Workflow

1. 🍴 Fork the repository
2. 🌿 Create a feature branch: git checkout -b feat/amazing-feature
3. ✏️ Make your changes
4. 🧪 Run tests: npm test
5. 🔍 Run linting: npm run lint
6. 💾 Commit your changes: git commit -m 'feat: add amazing feature'
7. 📤 Push to the branch: git push origin feat/amazing-feature
8. 🔄 Open a Pull Request

Code Style

This project uses:

• TypeScript for type safety
• ESLint with Google TypeScript Style (GTS) for linting
• Prettier for code formatting
• Conventional Commits for commit messages

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details.

🔗 Links

• 📖 Full Documentation
• 📦 npm Package
• 🐛 Issues
• 💬 Discussions
• ⭐ GitHub Repository

🙏 Acknowledgments

• Started as a fork of the original GeoFire library