init: v0.1.5

.astro/types.d.ts

@@ -0,0 +1 @@
+/// <reference types="astro/client" />

.github/workflows/deploy-docs.yml

@@ -0,0 +1,38 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  PUBLISH_DIR: ./docs/dist
+
+jobs:
+  build-and-deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 9
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build docs
+        run: pnpm build:docs
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ${{ env.PUBLISH_DIR }}

.gitignore

@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+tsconfig.app.tsbuildinfo

README.md

@@ -0,0 +1,67 @@
+# React Geojson Map
+
+> This is under development and not yet ready for production use.
+
+react-geojson-map is a library that enables declarative geospatial visualization using React Fiber.
+It seamlessly integrates React's component-based architecture with OpenLayers' mapping capabilities, providing developers with a robust solution for creating interactive and efficient map-based applications.
+
+## Features
+
+- Declarative components for defining map layers, sources, and interactions using JSX
+- CSS styling support for dynamic and themeable vector layer styling
+- Data source injection for streamlined integration and management of geospatial data sources
+
+## Installation
+
+Make sure you have Node.js installed (Node 18 recommended). Install the package using:
+
+```bash
+npm install react-geojson-map
+```
+
+## Usage
+
+Here's a basic example of how to use react-geojson-map:
+
+```jsx
+import React from "react";
+import { GeoMap, GeoDataSource } from "react-geojson-map";
+
+const MyMap = () => (
+  <GeoMap>
+    <GeoDataSource url="path/to/geojson" />
+    {/* Add other map components */}
+  </GeoMap>
+);
+export default MyMap;
+```
+
+## Development
+
+### Setup
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/behoney/react-geojson-map.git
+```
+
+2. Install dependencies:
+
+```bash
+pnpm install
+```
+
+### Run tests
+
+```bash
+pnpm test
+```
+
+## Contributing
+
+Contributions are welcome! Please open issues and submit pull requests for any enhancements or bug fixes. Make sure your code follows the project's coding standards and includes appropriate tests.
+
+## License
+
+MIT © behoney

docs/.astro/settings.json

@@ -0,0 +1,5 @@
+{
+	"_variables": {
+		"lastUpdateCheck": 1727923824793
+	}
+}

docs/.astro/types.d.ts

@@ -0,0 +1 @@
+/// <reference types="astro/client" />

docs/astro.config.mjs

@@ -0,0 +1,8 @@
+import react from "@astrojs/react";
+import { defineConfig } from "astro/config";
+
+export default defineConfig({
+	integrations: [react()],
+	site: "https://behoney.github.io",
+	base: process.env.NODE_ENV === "production" ? "/react-geojson-map" : "/",
+});

docs/docs/env.d.ts

@@ -0,0 +1 @@
+/// <reference path="../.astro/types.d.ts" />

docs/env.d.ts

@@ -0,0 +1 @@
+/// <reference path=".astro/types.d.ts" />