Merge pull request #42 from developmentseed/feature/docker

Adds Dockerfile for easy setup

Author: danielfdsilva

.dockerignore

@@ -0,0 +1,49 @@
+# Dependencies
+node_modules
+**/node_modules
+.pnp
+.pnp.js
+
+# Testing
+coverage
+**/coverage
+
+# Production builds
+dist
+**/dist
+build
+**/build
+
+# Cache directories
+.cache
+**/.cache
+.npm
+.eslintcache
+.vite
+.nx
+**/.parcel-cache
+
+# Environment files
+.env.*
+!.env.example
+
+# IDE specific files
+.idea
+.vscode
+*.swp
+*.swo
+
+# OS specific files
+.DS_Store
+Thumbs.db
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Temporary files
+*.tmp
+*.temp

.github/workflows/checks.yml

@@ -103,6 +103,10 @@ jobs:
   build:
     needs: prep
     runs-on: ubuntu-latest
+    # Just testing purposes
+    env:
+      REACT_APP_STAC_API: https://stac.eoapi.dev
+      PUBLIC_URL: http://stac-manager.ds.io
 
     steps:
       - name: Checkout
@@ -123,5 +127,8 @@ jobs:
       - name: Install
         run: npm install
 
+      - name: Create .env file
+        run: mv packages/client/.env.example packages/client/.env
+
       - name: Test
         run: npm run all:build

.github/workflows/deploy-gh.yml

@@ -47,6 +47,9 @@ jobs:
       - name: Install
         run: npm install
 
+      - name: Create .env file
+        run: mv packages/client/.env.example packages/client/.env
+
       - name: Setup SPA on Github Pages
         run: node packages/client/tasks/setup-gh-pages.mjs
 

.gitignore

@@ -58,4 +58,4 @@ tmp
 .tmp
 dist
 parcel-bundle-reports
-.nx
+.nx

Dockerfile

@@ -0,0 +1,18 @@
+# Use an official Node.js runtime as a parent image
+FROM node:slim
+
+# Set the working directory
+WORKDIR /app
+
+# Copy the rest of the application code
+COPY . .
+
+# Install dependencies
+RUN npm i
+RUN npm i -g http-server
+
+RUN npm run all:build
+
+EXPOSE 80
+
+ENTRYPOINT ["http-server", "-p", "80", "packages/client/dist"]

README.md

@@ -20,4 +20,20 @@ All the packages are located in the `packages` directory structured as follows:
 To set up the project for development, follow the instructions in the [development documentation](./DEVELOPMENT.md) and get familiar with the app architecture and the plugin system by reading the [technical documentation](./docs/README.md).
 
 ## License
-This project is licensed under the MIT license - see the LICENSE.md file for details.
+This project is licensed under the MIT license - see the LICENSE.md file for details.
+
+## Docker
+To run the STAC-Manager in a Docker container, you can use the provided Dockerfile.
+
+**Build the Docker image**
+```bash
+docker build -t stac-manager .
+```
+
+**Run the Docker container**
+```bash
+docker run --rm -p 8080:80 --name stac-manager -e 'PUBLIC_URL=http://your-url.com' stac-manager
+```
+
+> [!NOTE]
+> The application performs a complete build during container startup to ensure environment variables are properly integrated. This process may take a couple minutes to complete.

packages/client/.env

@@ -0,0 +1,60 @@
+# =============================================
+# STAC Manager Environment Example File
+# =============================================
+# IMPORTANT: DO NOT MODIFY THIS FILE!
+# Instead, create a copy named '.env' and modify that file.
+# This example file serves as a template and documentation.
+# =============================================
+
+# =================
+# App Configuration
+# =================
+
+# The title of the application shown in browser tab and headers
+APP_TITLE=STAC Manager
+
+# A brief description of the application for metadata purposes
+APP_DESCRIPTION=Plugin based STAC editor
+
+# The base URL where the app is being served from
+# DO NOT set this in the .env file. Set it as an environment variable before building.
+# See the README for instructions.
+# PUBLIC_URL= Do not set here
+
+# ===============
+# API Integration
+# ===============
+
+# URL of the STAC Browser instance (optional)
+# If not set, will default to Radiant Earth's STAC Browser
+REACT_APP_STAC_BROWSER=
+
+# URL of the STAC API endpoint (required)
+# This is the API the app will interact with for STAC operations
+REACT_APP_STAC_API=
+
+# ====================
+# Keycloak Auth Config
+# ====================
+# If not provided, authentication will be disabled.
+
+# Base URL of the Keycloak server
+REACT_APP_KEYCLOAK_URL=
+
+# Client ID registered in Keycloak
+REACT_APP_KEYCLOAK_CLIENT_ID=
+
+# Realm name in Keycloak
+REACT_APP_KEYCLOAK_REALM=
+
+# =================
+# Theme Customization
+# =================
+
+# Primary color for the application theme (hex color code)
+# Default: #6A5ACD (SlateBlue)
+# REACT_APP_THEME_PRIMARY_COLOR='#6A5ACD'
+
+# Secondary color for the application theme (hex color code)
+# Default: #048A81 (Teal)
+# REACT_APP_THEME_SECONDARY_COLOR='#048A81'

packages/client/.env.example

@@ -2,4 +2,5 @@
 # Environment
 ################################################
 
-.env.*
+.env*
+!.env.example

packages/client/.gitignore

@@ -8,6 +8,15 @@ See root README.md for instructions on how to install and run the project.
 
 ## Client specific instructions
 
+### Environment Configuration
+
+The application uses environment variables for configuration. A template file `.env.example` is provided as a template.
+
+To configure the application:
+1. Copy `.env.example` to `.env`
+2. Modify the `.env` file with your specific configuration values
+3. Never modify `.env.example` directly as it serves as documentation
+
 Some client options are controlled by environment variables. These are:
 ```
 # App config
@@ -66,4 +75,4 @@ icon-512.png            512x512
 favicon.png             32x32
 apple-touch-icon.png    360x360
 meta-image.png          1920x1080
-```
+```