diff --git a/CHANGELOG.md b/CHANGELOG.md index 8fd7789aa..7022663eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ - Use same version number for web and desktop versions - Add scheme type options for vector/raster tile - Add `tileSize` field for raster and raster-dem tile sources +- For local style development, configure CORS & expose a public directory - _...Add new stuff here..._ ### 🐞 Bug fixes diff --git a/README.md b/README.md index 10f9ce88c..b612f0ec1 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,27 @@ We ensure building and developing Maputnik works with the [current active LTS No Check out our [Internationalization guide](./src/locales/README.md) for UI text related changes. +### Local Style Development + +As a Maputnik developer, you can serve styles on the same server that used to develop the Maputnik app. This is useful if you want to test a style that is not public, or is in development. + +For example, + +1. Copy `unpublishedstyle.json` to the folder `/styles` +2. `npm run start` to start the `vite` local server +3. Verify by going to http://localhost:8888/styles/unpublishedstyle.json +4. Edit `src/config/styles.json`, then your new local style should be available: *Open > Gallery Styles* + +```json + { + "id": "localstyle", + "title": "unpublishedstyle.json", + "url": "http://localhost:8888/styles/unpublishedstyle.json" + }, +``` + +--- + ### Getting Involved Join the #maplibre or #maputnik slack channel at OSMUS: get an invite at https://slack.openstreetmap.us/ Read the the below guide in order to get familiar with how we do things around here. diff --git a/styles/.gitkeep b/styles/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/vite.config.ts b/vite.config.ts index e1ca3e83c..ef9e79e5a 100644 --- a/vite.config.ts +++ b/vite.config.ts @@ -5,8 +5,10 @@ import istanbul from "vite-plugin-istanbul"; export default defineConfig({ server: { + cors: true, port: 8888, }, + publicDir: 'styles', build: { sourcemap: true },