MapSearchify 🗺️

Real-time world mapping with lightning-fast search.

Embark on a journey of real-time exploration. Explore, share, and connect with the world.

Ahoy, Adventurers! 🌟

Welcome aboard the MapSearchify ship, where we set sail on a journey of innovation and discovery. Your presence during Hacktoberfest is like the wind in our sails, pushing us toward excellence.

We invite seasoned developers, visionary designers, and eager enthusiasts to join our crew. Chart a course for innovation, and let your insights and expertise be our guiding stars.

Come, shape the future of MapSearchify, and let's make waves together in the open-source community!

Table of Contents 📜

• Project Overview
• Recommended IDE Setup
• Type Support for .vue Imports in TypeScript
• Customize Configuration
• Getting started
• Contributing
• Issues
• License
• Tech Stack Used
• Acknowledgments

Project Overview 🪙

MapSearchify is a unique world-mapping platform inspired by Snapchat. It offers real-time tracking and lightning-fast search. We've harnessed the power of Algolia, MapboxGL.js, Vue InstantSearch, NuxtJS, and TypeScript to create a dynamic and user-friendly mapping platform.

Recommended IDE Setup ✅

For a smooth development experience, we recommend the following IDE setup:

• VSCode
• Volar (disable Vetur)
• TypeScript Vue Plugin (Volar)

Type Support for .vue Imports in TypeScript 🔍

TypeScript has its limitations when it comes to type information for .vue imports. We've replaced the tsc CLI with vue-tsc for type checking. To enable TypeScript's language service for .vue types in your code editor, you'll need the TypeScript Vue Plugin (Volar).

For faster performance, Volar offers a Take Over Mode. To enable it and :

1. Disable the built-in TypeScript Extension:

   • Run Extensions: Show Built-in Extensions from VSCode's command palette.
   • Find TypeScript and JavaScript Language Features, right-click, and select Disable (Workspace).

2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize Configuration 🛃

For customizing the project's configuration, please refer to the Vite Configuration Reference.

Getting started 🚀

1. To run the development server with hot-reloading:

npm install

2. To run the development server with hot-reloading:

npm run dev

3. Type-check, compile, and minify for production

npm run build

4. Run unit tests using Vitest:

   cd Run Unit Tests with Vitest

npm run test:unit

Contributing 🤝

Contributions to MapSearchify are welcome! Feel free to open issues, submit pull requests, or provide feedback to help improve the project. Check out the Contribution Guidelines for more details.

Issues 🐛

If you encounter any issues or have suggestions, please report them in the issue tracker.

License 📜

This project is licensed under the MIT License. Feel free to use and modify the code to suit your needs.

Tech Stack Used 🎨

• Nuxt.js
• TailwindCSS
• TypeScript
• MapboxGL.js
• Algolia
• Vue.js
• GitHub Actions

Acknowledgments 🙏

• Special thanks to the open-source community for their valuable contributions and tools that made this project possible.
• Inspired by the need for efficient content creation and sharing.