Skip to content

Commit

Permalink
Remove Storybook, cleanups (#860)
Browse files Browse the repository at this point in the history
1. Changed references to point to this new repo
2. Fixed docker image publishing to point to ghcr.io.
3. Remove survey link - the survey is closed and there's no point in
keeping it.
4. Remove storybook - Basically a storybook is the ability to look at
components and see how they look and interact with them.
It's a powerful tool for developing component library with "live"
documentation.
But it's an overkill for this project and I would like to reduce
maintenance costs.
Currently all the "stories" are in javascript and not in typescript and
it feels like a waste of time to try and maintain it, along with
updating the storybook library itself and everything around it.
  • Loading branch information
HarelM authored Jan 12, 2024
1 parent 6ed10a8 commit a62db14
Show file tree
Hide file tree
Showing 61 changed files with 1,023 additions and 7,851 deletions.
12 changes: 3 additions & 9 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:

steps:
- uses: actions/checkout@v4
- run: docker build -t docker.pkg.github.com/maputnik/editor/editor:main .
- run: docker build -t test-docker-image-build .

# build the editor
build-node:
Expand Down Expand Up @@ -53,17 +53,11 @@ jobs:
node-version-file: '.nvmrc'
- run: npm ci
- run: npm run build
- run: npm run build-storybook
- name: artifacts/editor
- name: artifacts/maputnik
uses: actions/upload-artifact@v1
with:
name: editor
name: maputnik
path: dist
- name: artifacts/storybook
uses: actions/upload-artifact@v1
with:
name: storybook
path: build/storybook

# Build and upload desktop CLI artifacts
- name: Set up Go
Expand Down
9 changes: 0 additions & 9 deletions .storybook/main.js

This file was deleted.

7 changes: 0 additions & 7 deletions .storybook/manager.js

This file was deleted.

8 changes: 0 additions & 8 deletions .storybook/maputnik.theme.js

This file was deleted.

2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ RUN npm install

# Build maputnik
COPY . .
RUN npm run build
RUN npx vite build

#---------------------------------------------------------------------------
# Create a clean nginx-alpine slim image with just the build results
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<img width="200" alt="Maputnik logo" src="https://cdn.jsdelivr.net/gh/maputnik/design/logos/logo-color.png" />

# Maputnik
[![GitHub CI status](https://github.com/maputnik/editor/workflows/ci/badge.svg)][github-action-ci]
[![GitHub CI status](https://github.com/maplibre/maputnik/workflows/ci/badge.svg)][github-action-ci]
[![License](https://img.shields.io/badge/license-MIT-blue.svg)][license]

[github-action-ci]: https://github.com/maputnik/editor/actions?query=workflow%3Aci
[github-action-ci]: https://github.com/maplibre/maputnik/actions?query=workflow%3Aci
[license]: https://tldrlegal.com/license/mit-license

A free and open visual editor for the [MapLibre GL styles](https://maplibre.org/maplibre-style-spec/)
Expand All @@ -14,18 +14,18 @@ targeted at developers and map designers.
## Usage

- :link: Design your maps online at **<https://www.maplibre.org/maputnik/>** (all in local storage)
- :link: Use the [Maputnik CLI](https://github.com/maputnik/editor/wiki/Maputnik-CLI) for local style development
- :link: Use the [Maputnik CLI](https://github.com/maplibre/maputnik/wiki/Maputnik-CLI) for local style development
- In a Docker, run this command and browse to http://localhost:8888, Ctrl+C to stop the server.

```bash
docker run -it --rm -p 8888:8888 maputnik/editor
docker run -it --rm -p 8888:8888 ghcr.io/maplibre/maputnik:main
```

## Documentation

The documentation can be found in the [Wiki](https://github.com/maputnik/editor/wiki). You are welcome to collaborate!
The documentation can be found in the [Wiki](https://github.com/maplibre/maputnik/wiki). You are welcome to collaborate!

- :link: **Study the [Maputnik Wiki](https://github.com/maputnik/editor/wiki)**
- :link: **Study the [Maputnik Wiki](https://github.com/maplibre/maputnik/wiki)**
- :video_camera: Design a map from Scratch https://youtu.be/XoDh0gEnBQo

[![Design Map from Scratch](https://j.gifs.com/g5XMgl.gif)](https://youtu.be/XoDh0gEnBQo)
Expand Down
Binary file removed media/sponsors/dreipol.png
Binary file not shown.
Binary file removed media/sponsors/geofabrik.png
Binary file not shown.
Binary file removed media/sponsors/klokantech.png
Binary file not shown.
Binary file removed media/sponsors/orbicon_informatik.png
Binary file not shown.
Binary file removed media/sponsors/terranodo.png
Binary file not shown.
Binary file removed media/sponsors/wemap.jpg
Binary file not shown.
Loading

0 comments on commit a62db14

Please sign in to comment.