Skip to content

docs: fix README typos and Docker Compose syntax #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KarimTamani merged 1 commit into from
Aug 4, 2026
Merged

docs: fix README typos and Docker Compose syntax #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions DOCKER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ This guide explains how to run StackRender using Docker.
The easiest way to run StackRender:

```bash
docker-compose up -d
docker compose up -d
```

The application will be available at `http://localhost:8080`

To stop the application:

```bash
docker-compose down
docker compose down
```

### Using Docker CLI
Expand Down Expand Up @@ -114,7 +114,7 @@ docker logs stackrender
Or with Docker Compose:

```bash
docker-compose logs
docker compose logs
```

### Port Already in Use
Expand Down
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@

</h4>

# Welcom to StackRender ⚡
# Welcome to StackRender ⚡
StackRender was born from the need to automate backend development, covering everything from the database to the final API endpoint. Our first step toward this long-term vision is to provide a **next-generation, free, open-source database schema diagram generator**.

StackRender helps you go from **specifications** to a **fully functional, production-ready database** that can be exported in your preferred SQL dialect: **MySQL, PostgreSQL, MariaDB, or SQLite**.
StackRender helps you go from **specifications** to a **fully functional, production-ready database** that can be exported in your preferred SQL dialect: **MySQL, PostgreSQL, MariaDB, SQLite, Oracle, or SQL Server**.

## Main features

- **Interactive Diagram UI** – Visually design and manage your database schemas with an intuitive drag-and-drop interface.
- **In-Depth Tables & Columns Control** – Fully customize tables, columns, types, and constraints.
- **Indices Suggestions** – Receive recommendations to optimize database performance.
- **Index Suggestions** – Receive recommendations to optimize database performance.
- **Import / Export SQL DDL** – Easily import existing schemas or export your design as SQL scripts.
- **Foreign Key Cycle Detection** – Identify and resolve circular dependencies in relationships.
- **AI-Powered Database Assistant** – (Cloud version) Generate database diagrams from specifications and perform additional operations such as schema enrichment, soft-delete implementation, and automatic documentation generation.
Expand Down Expand Up @@ -53,7 +53,7 @@ The easiest way to run StackRender locally is using Docker:

```bash
# Build and run using Docker Compose
docker-compose up
docker compose up

# Or build and run using Docker directly
docker build -t stackrender .
Expand All @@ -69,6 +69,8 @@ npm install
npm run dev
```

Then visit `http://localhost:3000` in your browser.

### How to Build
Install dependencies and create a production build:
```bash
Expand Down