10 Commits

Author SHA1 Message Date
KarimTamani 7e7f7c7397 Increase Node memory to prevent out-of-memory errors during build 2026-03-29 16:08:59 +01:00
KarimTamani e342ffa831 Merge remote-tracking branch 'origin/main' into copilot/dockerize-the-application 2026-03-29 14:22:50 +01:00
KarimTamani f1656fafcd Updated Reade.me 2026-03-29 14:06:22 +01:00
KarimTamani caca671b36 Add View docs link in import database dialog 2026-03-29 14:04:49 +01:00
Tamani Karim 1b1c8ebdf6 Merge pull request #3 from stackrender/KarimTamani-patch-1
Add docs link
2026-03-28 19:25:40 +01:00
copilot-swe-agent[bot] f68b0c97bf Add comprehensive Docker documentation
Co-authored-by: oovaa <103980029+oovaa@users.noreply.github.com>
2025-11-17 08:23:23 +00:00
copilot-swe-agent[bot] 42699038ad Remove obsolete version field from docker-compose.yml
Co-authored-by: oovaa <103980029+oovaa@users.noreply.github.com>
2025-11-17 08:21:29 +00:00
copilot-swe-agent[bot] f594b4e938 Add Docker support with Dockerfile, docker-compose, and nginx config
Co-authored-by: oovaa <103980029+oovaa@users.noreply.github.com>
2025-11-17 08:17:58 +00:00
copilot-swe-agent[bot] f6511df039 Initial exploration and planning for dockerization
Co-authored-by: oovaa <103980029+oovaa@users.noreply.github.com>
2025-11-17 07:41:02 +00:00
copilot-swe-agent[bot] 9f6b61643f Initial plan 2025-11-17 07:36:56 +00:00
9 changed files with 377 additions and 42 deletions
+53
View File
@@ -0,0 +1,53 @@
# Dependencies
node_modules
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
# Build outputs
dist
dist-ssr
*.local
# Environment files
.env
.env.local
.env.development.local
.env.test.local
.env.production.local
# Editor directories and files
.vscode
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
# Git
.git
.gitignore
# Docker
Dockerfile
.dockerignore
docker-compose.yml
# Misc
README.md
LICENSE
CODE_OF_CONDUCT.md
CONTRIBUTING.md
SECURITY.md
# Lock files (we keep package-lock.json but ignore others)
pnpm-lock.yaml
yarn.lock
bun.lockb
# Vite cache
vite.config.ts.timestamp-*
+160
View File
@@ -0,0 +1,160 @@
# Docker Deployment Guide
This guide explains how to run StackRender using Docker.
## Quick Start
### Using Docker Compose (Recommended)
The easiest way to run StackRender:
```bash
docker-compose up -d
```
The application will be available at `http://localhost:8080`
To stop the application:
```bash
docker-compose down
```
### Using Docker CLI
Build the image:
```bash
docker build -t stackrender .
```
Run the container:
```bash
docker run -d -p 8080:80 --name stackrender stackrender
```
Stop and remove the container:
```bash
docker stop stackrender
docker rm stackrender
```
## Configuration
### Port Mapping
By default, the application runs on port 80 inside the container and is mapped to port 8080 on the host. You can change this in `docker-compose.yml`:
```yaml
ports:
- "YOUR_PORT:80"
```
Or when using Docker CLI:
```bash
docker run -d -p YOUR_PORT:80 --name stackrender stackrender
```
### Health Check
The Docker Compose configuration includes a health check that verifies the application is responding correctly:
```yaml
healthcheck:
test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:80/"]
interval: 30s
timeout: 10s
retries: 3
start_period: 40s
```
## Architecture
### Multi-Stage Build
The Dockerfile uses a multi-stage build approach:
1. **Builder Stage**: Uses Node.js 20 to install dependencies and build the application
2. **Production Stage**: Uses Nginx Alpine to serve the static files
This approach minimizes the final image size by excluding build tools and dependencies.
### Nginx Configuration
The application uses a custom Nginx configuration (`nginx.conf`) that:
- Enables gzip compression for better performance
- Sets security headers (X-Frame-Options, X-Content-Type-Options, X-XSS-Protection)
- Handles client-side routing (React Router)
- Configures caching for static assets
## Troubleshooting
### Build Issues
If you encounter SSL certificate issues during the build, the Dockerfile includes a workaround:
```dockerfile
RUN npm config set strict-ssl false && npm install
```
This is necessary in some build environments with certificate validation issues.
### Container Not Starting
Check the logs:
```bash
docker logs stackrender
```
Or with Docker Compose:
```bash
docker-compose logs
```
### Port Already in Use
If port 8080 is already in use, you can change it in `docker-compose.yml` or use a different port with Docker CLI:
```bash
docker run -d -p 8081:80 --name stackrender stackrender
```
## Development
For development, it's recommended to run the application directly with Node.js instead of Docker:
```bash
npm install
npm run dev
```
Docker is primarily intended for production deployments or testing the production build locally.
## Production Deployment
For production deployments:
1. Build the image:
```bash
docker build -t stackrender:production .
```
2. Push to your container registry:
```bash
docker tag stackrender:production your-registry/stackrender:latest
docker push your-registry/stackrender:latest
```
3. Deploy using your orchestration tool (Kubernetes, Docker Swarm, etc.)
## Additional Resources
- [Docker Documentation](https://docs.docker.com/)
- [Docker Compose Documentation](https://docs.docker.com/compose/)
- [Nginx Documentation](https://nginx.org/en/docs/)
+36
View File
@@ -0,0 +1,36 @@
# Build stage - using standard debian-based node image for better compatibility
FROM node:20 AS builder
WORKDIR /app
# Copy package files
COPY package*.json ./
# Install dependencies
# Note: strict-ssl is disabled to handle potential certificate issues in some build environments
RUN npm config set strict-ssl false && npm install
# Copy source files
COPY . .
# Increase Node memory to prevent out-of-memory errors during build
ENV NODE_OPTIONS=--max-old-space-size=4096
# Build the application
RUN npm run build
# Production stage
FROM nginx:alpine
# Copy built files from builder stage
COPY --from=builder /app/dist /usr/share/nginx/html
# Copy nginx configuration
COPY nginx.conf /etc/nginx/conf.d/default.conf
# Expose port 80
EXPOSE 80
# Start nginx
CMD ["nginx", "-g", "daemon off;"]
+23 -5
View File
@@ -45,18 +45,36 @@ And more coming very soon!
Use the [cloud version](https://www.stackrender.io) or deploy locally to start designing your database schemas in minutes.
### How to Use
### How to Use Locally
#### Using Docker (Recommended)
The easiest way to run StackRender locally is using Docker:
```bash
# Build and run using Docker Compose
docker-compose up
# Or build and run using Docker directly
docker build -t stackrender .
docker run -p 8080:80 stackrender
```
Then visit `http://localhost:8080` in your browser.
#### Using Node.js
Install dependencies and start the development server:
```text
```bash
npm install
npm run dev
```
### How to Build
Install dependencies and start the production build:
```text
Install dependencies and create a production build:
```bash
npm install
npm run start
npm run build
```
## Try Using It in the Cloud
1. Visit [StackRender.io](https://www.stackrender.io)
+18
View File
@@ -0,0 +1,18 @@
services:
stackrender:
build:
context: .
dockerfile: Dockerfile
image: stackrender:latest
container_name: stackrender
ports:
- "8080:80"
restart: unless-stopped
environment:
- NODE_ENV=production
healthcheck:
test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:80/"]
interval: 30s
timeout: 10s
retries: 3
start_period: 40s
+28
View File
@@ -0,0 +1,28 @@
server {
listen 80;
server_name localhost;
root /usr/share/nginx/html;
index index.html;
# Gzip compression
gzip on;
gzip_vary on;
gzip_min_length 1024;
gzip_types text/plain text/css text/xml text/javascript application/javascript application/xml+rss application/json;
# Security headers
add_header X-Frame-Options "SAMEORIGIN" always;
add_header X-Content-Type-Options "nosniff" always;
add_header X-XSS-Protection "1; mode=block" always;
# Handle client-side routing
location / {
try_files $uri $uri/ /index.html;
}
# Cache static assets
location ~* \.(js|css|png|jpg|jpeg|gif|ico|svg|wasm)$ {
expires 1y;
add_header Cache-Control "public, immutable";
}
}
@@ -1,8 +1,6 @@
import {
IconBrandDiscord,
IconBrandGithub,
IconBrandX,
IconSparkles,
IconTableAlias,
IconVectorSpline,
} from '@tabler/icons-react'
@@ -7,7 +7,7 @@ import { sql } from '@codemirror/lang-sql';
import { DatabaseDialect, ImportDatabaseMethod, ImportDatabaseOption, ImportMethodType, MARIADB_DUMP_EXAMPLE, MARIADB_DUMP_INSTRUCTIONS, MYSQL_DUMP_EXAMPLE, MYSQL_DUMP_INSTRUCTIONS, PG_DUMP_EXAMPLE, PG_DUMP_INSTRUCTIONS, SQLITE_DUMP_EXAMPLE, SQLITE_DUMP_INSRUCTION } from "@/lib/database";
import { useDatabase, useDatabaseOperations } from "@/providers/database-provider/database-provider";
import { AlertCircleIcon, Code } from "lucide-react";
import { AlertCircleIcon, Code, HelpCircle } from "lucide-react";
import { SqlToDatabase } from "@/utils/render/parsers/sql_to_database";
import Clipboard from "@/components/clipboard";
import { Trans } from 'react-i18next';
@@ -19,9 +19,12 @@ import { Label } from "@/components/ui/label";
import { useTheme } from "@/providers/theme-provider/theme-provider";
import { cn } from "@/lib/utils";
import { Alert, AlertDescription, AlertTitle } from "@/components/ui/alert";
import { buttonVariants } from "@/components/ui/button";
const options: ImportDatabaseOption[] = [{
dialect: DatabaseDialect.POSTGRES,
docUrl: "https://stackrender.io/docs/import/postgresql",
methods: [{
id: "pg_dump",
name: "pg_dump",
@@ -40,6 +43,7 @@ const options: ImportDatabaseOption[] = [{
}]
}, {
dialect: DatabaseDialect.MYSQL,
docUrl: "https://stackrender.io/docs/import/mysql",
methods: [{
id: "mysql_dump",
name: "mysqldump",
@@ -57,6 +61,7 @@ const options: ImportDatabaseOption[] = [{
}
, {
dialect: DatabaseDialect.MARIADB,
docUrl: "https://stackrender.io/docs/import/mariadb",
methods: [{
id: "mariadb-dump",
name: "mariadb-dump",
@@ -87,6 +92,7 @@ const options: ImportDatabaseOption[] = [{
}, {
dialect: DatabaseDialect.SQLITE,
docUrl: "https://stackrender.io/docs/import/sqlite",
methods: [{
id: "sqlite3",
name: "Sqlite3",
@@ -103,6 +109,8 @@ const options: ImportDatabaseOption[] = [{
}]
}
];
const ImportDatabaseModal: React.FC<ModalProps> = ({ isOpen, onOpenChange }) => {
const { t } = useTranslation();
@@ -199,41 +207,56 @@ const ImportDatabaseModal: React.FC<ModalProps> = ({ isOpen, onOpenChange }) =>
<p className="text-sm text-muted-foreground">
{t("modals.import_database.import_options")}
</p>
{
<RadioGroup
onValueChange={onImportMethodChange}
value={selectedMethodId}
className="flex ">
{
currentOption?.methods.map((method: ImportDatabaseMethod) => (
<Label htmlFor={method.id}
key={method.id}
className={cn(" h-8 px-2 rounded-md border hover:bg-secondary cursor-pointer flex items-center gap-1 ",
(selectedMethodId == method.id) ? "border-primary bg-primary/20 " : "",
)}>
<RadioGroupItem value={method.id} id={method.id} className="sr-only" />
{
method.icon &&
<div >
{method.icon}
</div>
}
<img
src={method.logo}
className="rounded-none h-4 "
/>
<span >
{method.name}
</span>
</Label>
))
<div className="flex flex-col lg:flex-row-reverse gap-2 justify-between items-center ">
<a
className={
buttonVariants({
variant: "outline"
})
}
</RadioGroup>
href={currentOption?.docUrl}
target="_blank"
>
{t("modals.import_database.view_docs")}
}
<HelpCircle className="size-4 text-muted-foreground" />
</a>
{
<RadioGroup
onValueChange={onImportMethodChange}
value={selectedMethodId}
className="flex ">
{
currentOption?.methods.map((method: ImportDatabaseMethod) => (
<Label htmlFor={method.id}
key={method.id}
className={cn(" h-8 px-2 rounded-md border hover:bg-secondary cursor-pointer flex items-center gap-1 ",
(selectedMethodId == method.id) ? "border-primary bg-primary/20 " : "",
)}>
<RadioGroupItem value={method.id} id={method.id} className="sr-only" />
{
method.icon &&
<div >
{method.icon}
</div>
}
<img
src={method.logo}
className="rounded-none h-4 "
/>
<span >
{method.name}
</span>
</Label>
))
}
</RadioGroup>
}
</div>
{
selectedImportMethod?.type == ImportMethodType.DUMP &&
<div className="space-y-2">
+2 -1
View File
@@ -88,7 +88,8 @@ export interface ImportDatabaseMethod {
export interface ImportDatabaseOption {
dialect: DatabaseDialect,
methods: ImportDatabaseMethod[]
methods: ImportDatabaseMethod[] ;
docUrl? : string ;
}