Skip to content

Commit 6293615

Browse files
geoapifygeoapify
committed
Merge pull request #21 from geoapify/GD-130-fix-issues
2 parents e718935 + 439c2f1 commit 6293615

50 files changed

Lines changed: 25533 additions & 30219 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
root = true
2-
3-
[*]
4-
charset = utf-8
5-
indent_style = space
6-
indent_size = 2
7-
end_of_line = lf
8-
insert_final_newline = true
9-
trim_trailing_whitespace = true
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true

‎.github/workflows/deploy-docs.yml‎

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
1-
name: Deploy MkDocs to GitHub Pages
2-
3-
on:
4-
push:
5-
branches:
6-
- master
7-
8-
jobs:
9-
deploy:
10-
runs-on: ubuntu-latest
11-
steps:
12-
- name: Checkout
13-
uses: actions/checkout@v4
14-
15-
# --- 1. Build React library and demo ---
16-
- name: Set up Node.js
17-
uses: actions/setup-node@v4
18-
with:
19-
node-version: '20'
20-
21-
- name: Install dependencies
22-
run: |
23-
npm ci
24-
25-
- name: Build React library
26-
run: |
27-
npm run build
28-
29-
- name: Build demo application
30-
run: |
31-
cd example && npm ci && npm run build
32-
33-
# --- 2. Build the MkDocs documentation ---
34-
- name: Set up Python 3
35-
uses: actions/setup-python@v5
36-
with:
37-
python-version: '3.x'
38-
39-
- name: Install MkDocs dependencies
40-
working-directory: docs-site
41-
run: |
42-
python -m pip install --upgrade pip
43-
python -m pip install -r requirements.txt
44-
45-
- name: Build MkDocs site
46-
working-directory: docs-site
47-
run: mkdocs build --strict
48-
49-
# --- 3. Deploy everything to GitHub Pages ---
50-
- name: Deploy to GitHub Pages
51-
uses: peaceiris/actions-gh-pages@v3
52-
with:
53-
publish_dir: docs-site/site
54-
github_token: ${{ secrets.GITHUB_TOKEN }}
55-
force_orphan: true
56-
1+
name: Deploy MkDocs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
15+
# --- 1. Build React library and demo ---
16+
- name: Set up Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: '20'
20+
21+
- name: Install dependencies
22+
run: |
23+
npm ci
24+
25+
- name: Build React library
26+
run: |
27+
npm run build
28+
29+
- name: Build demo application
30+
run: |
31+
cd example && npm ci && npm run build
32+
33+
# --- 2. Build the MkDocs documentation ---
34+
- name: Set up Python 3
35+
uses: actions/setup-python@v5
36+
with:
37+
python-version: '3.x'
38+
39+
- name: Install MkDocs dependencies
40+
working-directory: docs-site
41+
run: |
42+
python -m pip install --upgrade pip
43+
python -m pip install -r requirements.txt
44+
45+
- name: Build MkDocs site
46+
working-directory: docs-site
47+
run: mkdocs build --strict
48+
49+
# --- 3. Deploy everything to GitHub Pages ---
50+
- name: Deploy to GitHub Pages
51+
uses: peaceiris/actions-gh-pages@v3
52+
with:
53+
publish_dir: docs-site/site
54+
github_token: ${{ secrets.GITHUB_TOKEN }}
55+
force_orphan: true
56+

‎.gitignore‎

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
1-
2-
# See https://help.github.com/ignore-files/ for more about ignoring files.
3-
4-
# dependencies
5-
node_modules
6-
7-
# builds
8-
build
9-
dist
10-
.rpt2_cache
11-
12-
# misc
13-
.DS_Store
14-
.env
15-
.env.local
16-
.env.development.local
17-
.env.test.local
18-
.env.production.local
19-
20-
npm-debug.log*
21-
yarn-debug.log*
22-
yarn-error.log*
23-
24-
#vscode
25-
.vscode
26-
/.idea/
27-
28-
# Documentation
29-
docs-site/venv/
30-
docs-site/site/
31-
docs-site/.cache/
1+
2+
# See https://help.github.com/ignore-files/ for more about ignoring files.
3+
4+
# dependencies
5+
node_modules
6+
7+
# builds
8+
build
9+
dist
10+
.rpt2_cache
11+
12+
# misc
13+
.DS_Store
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*
21+
22+
#vscode
23+
.vscode
24+
/.idea/
25+
26+
# Documentation
27+
docs-site/venv/
28+
docs-site/site/
29+
docs-site/.cache/
30+
config.bat

‎.prettierrc‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
{
2-
"singleQuote": true,
3-
"jsxSingleQuote": true,
4-
"semi": false,
5-
"tabWidth": 2,
6-
"bracketSpacing": true,
7-
"jsxBracketSameLine": false,
8-
"arrowParens": "always"
9-
}
1+
{
2+
"singleQuote": true,
3+
"jsxSingleQuote": true,
4+
"semi": false,
5+
"tabWidth": 2,
6+
"bracketSpacing": true,
7+
"jsxBracketSameLine": false,
8+
"arrowParens": "always"
9+
}

‎.travis.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
language: node_js
2-
node_js:
3-
- 12
4-
- 10
1+
language: node_js
2+
node_js:
3+
- 12
4+
- 10

‎BUILD.md‎

Lines changed: 87 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,87 @@
1-
# Build & Run Guide
2-
3-
This repository contains the React component library, a demo app, and the MkDocs documentation site.
4-
Use this guide to set up a local workstation and verify changes before publishing.
5-
6-
## 1. Prerequisites
7-
8-
- Node.js 18+ and npm 10+
9-
- For the documentation site: Python 3.9+ with `pip`
10-
11-
## 2. Install Dependencies
12-
13-
```bash
14-
npm install
15-
```
16-
17-
This installs all workspace packages, including the demo app dependencies.
18-
19-
## 3. Build the Library
20-
21-
```bash
22-
npm run build
23-
```
24-
25-
- Runs `microbundle-crl` to build the component library
26-
- Outputs the distributable package under `dist/`
27-
- Add `npm run start` to watch for changes during development
28-
29-
## 4. Run Quality Gates
30-
31-
- **Unit tests:** `npm run test`
32-
- **Linting:** `npm run lint`
33-
34-
These should be clean before submitting changes or publishing.
35-
36-
## 5. Run the Demo Application
37-
38-
The demo showcases three interactive examples:
39-
40-
1. **Address Form** – Complete address collection workflow
41-
2. **Events Showcase** – Real-time event logger with all 14 events
42-
3. **Playground** – Test all configuration options
43-
44-
### Steps:
45-
46-
1. Update the API key in `example/src/config.js`. The checked-in key is for demos only and may be throttled.
47-
2. Start the dev server:
48-
```bash
49-
cd example
50-
npm install
51-
npm start # serves the demo on http://localhost:3000
52-
```
53-
3. The demo watches both the library and app; rebuilding the library will refresh the demo automatically.
54-
55-
## 6. Preview / Build the Documentation Site
56-
57-
The docs live under `docs-site/` and use MkDocs Material.
58-
59-
```bash
60-
cd docs-site
61-
62-
# Create virtual environment (first time only)
63-
python3 -m venv venv
64-
65-
# Activate virtual environment
66-
source venv/bin/activate # On Windows: venv\Scripts\activate
67-
68-
# Install dependencies
69-
pip install -r requirements.txt
70-
71-
# Live preview at http://127.0.0.1:8000
72-
mkdocs serve
73-
74-
# Or build static site into site/ directory
75-
mkdocs build
76-
```
77-
78-
## 7. Publishing
79-
80-
### Library
81-
82-
1. Ensure `npm run build` output is up to date
83-
2. Update version in `package.json` if needed
84-
3. From the repo root:
85-
```bash
86-
npm publish --access public
87-
```
1+
# Build & Run Guide
2+
3+
This repository contains the React component library, a demo app, and the MkDocs documentation site.
4+
Use this guide to set up a local workstation and verify changes before publishing.
5+
6+
## 1. Prerequisites
7+
8+
- Node.js 18+ and npm 10+
9+
- For the documentation site: Python 3.9+ with `pip`
10+
11+
## 2. Install Dependencies
12+
13+
```bash
14+
npm install
15+
```
16+
17+
This installs all workspace packages, including the demo app dependencies.
18+
19+
## 3. Build the Library
20+
21+
```bash
22+
npm run build
23+
```
24+
25+
- Runs `microbundle-crl` to build the component library
26+
- Outputs the distributable package under `dist/`
27+
- Add `npm run start` to watch for changes during development
28+
29+
## 4. Run Quality Gates
30+
31+
- **Unit tests:** `npm run test`
32+
- **Linting:** `npm run lint`
33+
34+
These should be clean before submitting changes or publishing.
35+
36+
## 5. Run the Demo Application
37+
38+
The demo showcases three interactive examples:
39+
40+
1. **Address Form** – Complete address collection workflow
41+
2. **Events Showcase** – Real-time event logger with all 14 events
42+
3. **Playground** – Test all configuration options
43+
44+
### Steps:
45+
46+
1. Update the API key in `example/src/config.js`. The checked-in key is for demos only and may be throttled.
47+
2. Start the dev server:
48+
```bash
49+
cd example
50+
npm install
51+
npm start # serves the demo on http://localhost:3000
52+
```
53+
3. The demo watches both the library and app; rebuilding the library will refresh the demo automatically.
54+
55+
## 6. Preview / Build the Documentation Site
56+
57+
The docs live under `docs-site/` and use MkDocs Material.
58+
59+
```bash
60+
cd docs-site
61+
62+
# Create virtual environment (first time only)
63+
python3 -m venv venv
64+
65+
# Activate virtual environment
66+
source venv/bin/activate # On Windows: venv\Scripts\activate
67+
68+
# Install dependencies
69+
pip install -r requirements.txt
70+
71+
# Live preview at http://127.0.0.1:8000
72+
mkdocs serve
73+
74+
# Or build static site into site/ directory
75+
mkdocs build
76+
```
77+
78+
## 7. Publishing
79+
80+
### Library
81+
82+
1. Ensure `npm run build` output is up to date
83+
2. Update version in `package.json` if needed
84+
3. From the repo root:
85+
```bash
86+
npm publish --access public
87+
```

0 commit comments

Comments
 (0)