kiwijos / vteam-demo-app

Project Archive Notice

As of January 28, 2024, this project is officially archived.

Background

This project was initially developed as a Proof of Concept (POC) to demonstrate using MapLibre GL JS in SvelteKit. It served its intended purpose and provided some valuable insights.

Archive Status

• No Longer Maintained: The project is no longer being actively developed or maintained.
• Read-Only: The repository has been set to read-only mode. This means no new issues, pull requests, or changes will be accepted.
• No Support: We will no longer be providing support for this project. This includes addressing issues, bugs, or requests.
• Documentation: All existing documentation will remain available for reference purposes.

Implications

• Use at Your Own Risk: Any use of this project's codebase is at your own risk. The project is no longer updated for security, compatibility, or any other changes.
• No Future Updates: There will be no new features, fixes, or updates. The project's current state is its final form.

Acknowledgements

Special thanks to the following GitHub repositories for their inspiration and resources:

• watergis/sveltekit-maplibre-boilerplate
• maptiler/svelte-template-maplibre-gl-js

---

SvelteKit app using MapLibre GL JS

A web map application with SvelteKit using MapLibre GL JS.

API KEY

Create a .env file or simply copy and/or rename the .env.example file.

Open the .env file, you will need to add/replace MAPTILER_API_KEY with your own MapTiler API key.

Your MapTiler account access key is on your MapTiler Cloud account page.

ℹ️ If you don't have an API KEY, you can create it for free at https://www.maptiler.com/cloud/

Developing

Once you've copied the project and installed dependencies with npm install, start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of the app:

npm run build

You can preview the production build with npm run preview or run it with node -r dotenv/config build.

.env files are not automatically loaded in production, hence the use of dotenv.

Build and Deploy using Docker

To create and deploy a production version of the app using Docker:

# build the image
docker compose build

# and start the app running in the background
docker compose up -d

Using the app as a PWA

The app can be installed to your computer or phone from the browser.

When run in a secure context, the service worker will intercept requests and either serve the cached version or fetch the resource from the network if possible.

Prerendered pages and static assets can always be served from the cache. In addition, any pages visited will be cached and can be served later even if there is no internet connection.

vteam-demo-app's Issues

idaloof testing

hello

Test

Test-issue

Fake it til you make it

Set up authentication for protected routes

• Restrict /admin routes to admin users only
• Restrict /me routes to personal users only