Skip to content

Latest commit

 

History

History
184 lines (139 loc) · 7.5 KB

README.md

File metadata and controls

184 lines (139 loc) · 7.5 KB
Raw

Logo

Nimiq's Crypto Map

The Crypto Map by Nimiq.
Explore the world and find places to spend your crypto.

Locations Cryptos Providers

Get involved!

Crypto Map | Wallet | Cryptopayment Link

Contributing

All PRs all welcome! Join our Telegram and we will get you up and running!

Dev Setup

Important

You need to have a valid .env file in the root of the project.

  1. Clone the repo
  2. Run pnpm i
  3. Run pnpm dev to run the app or run pnpm story:dev to run histoire

Database

The app only can make read operations to the database, all read operations can be found in database/getters.ts. The bot and supabase can make write operations to the database, database/functions.ts. Write operations require authentication.

Bot

The bot has been developed with the Deno Slack SDK, which requires Deno.

Supabase Functions

Since we are deploying the Edge Function in Supabase, we need to use Deno to develop the functions. Read more about how we use Supabase Functions.

Supabase CLI for Supabase Edge Functions

You can install the Supabase CLI with:

npm i supabase --save-dev # Or use npx supabase ...
Setting you .env file

Initialize your .env file with:

cp ./supabase/functions/.env.example ./supabase/functions/.env 
# Add the env vars in ./supabase/functions/.env

For deploying functions you need to set some env vars, you can do that with:

supabase secrets set --env-file ./supabase/functions/.env
supabase secrets list
Deploying functions

And deploy them with:

supabase functions deploy generate-locations-clusters-set --import-map supabase/import_map.json

Data flow

This section explains how we load the data from Supabase and how we use it in the application.

Firstly, we run the Generate Locations Clusters Set function every time we update our main locations table, which contains all the data from all the locations we store.

This function will populate the locations_clusters_set table. This is a table that contains all the clusters from zoom level 3 (minimum zoom level in the application) to level 14. When the user explores the map at a zoom level between 3 and 14, we will load the clusters from this table.

When fetching data for the clusters, there may be locations that are not in the cluster set, so the request for the clusters will return an object like { singles: MapLocation[], clusters: Cluster[] }.

This solution works well when the zoom level is between 3 and 14. However, the higher the zoom level, the more clusters we will have but the less computation is required to generate the clusters as there are fewer locations in the view. Therefore, from level 15 onwards, we will load the locations directly from the locations table and cluster them in the client.

Each time we load a cluster or location, we will store it in memory, and before making any HTTP request or computation, we will check that we have the data in memory. See src/stores/locations.ts and src/stores/cluster.ts for more details.

The code for the clustering can be found in shared/compute-cluster.ts. This function is used in the src/stores/cluster.ts store and in the supabase/functions/generate-locations_clusters-set.ts function.

If the user uses any kind of filters, then we will load the locations directly from the locations table and apply the filters in the client. The main reason is that the amount of combinations of filters is too big, and we cannot store all the possible combinations in the database. We could use some strategies to mitigate this issue, but the amount of lines of code involved is too big, and the performance gain is not worth it.

Embed the map in an iframe

You can embed the map in an iframe with the following code:

<iframe src="https://map.nimiq.com/" width="100%" height="600" frameborder="0" style="border:0" allowfullscreen></iframe>

You can customize the app with some query parameters:

Parameter Description Example Comments
Map position Position of the map https://map.nimiq.com/@{lat},{lng},{zoom}
uuid UUID of the location https://map.nimiq.com/?uuid={uuid} Don't use it with Map position if you don't know the coordinates of the location
Language Language of the app https://map.nimiq.com/?lang={language} Check supported languages`
Layout Layout of the app https://map.nimiq.com/?layout={layout} Check supported layouts
Modal Modal to show https://map.nimiq.com/?modal={modal} Check supported modals
Nested Modal Nest modal to show https://map.nimiq.com/?nested={nested} Check supported modals. Use it with modal
Search Search to show https://map.nimiq.com/?search={search}

🏗️ Stack

For the app:

  • TypeScript TypeScript extends JavaScript by adding types.
  • Vue An approachable, performant and versatile framework for building web user interfaces.
  • VueUse Collection of Essential Vue Composition Utilities
  • Radix UI for porting Radix UI to Vue
  • GMaps Build awesome apps with Google’s knowledge of the real world
  • Tailwind A utility-first CSS framework for rapid UI development.
  • Supabase The open source Firebase alternative. Instant APIs, scalable PostgreSQL, and realtime subscriptions.
  • Deno Slack SDK A Deno SDK for Slack's APIs.

TODO

  • Binance Pay
  • Tooltip in banner
  • Search desktop
  • Check all providers