diff --git a/DOCKER.md b/DOCKER.md index db348bf..404505e 100644 --- a/DOCKER.md +++ b/DOCKER.md @@ -9,7 +9,7 @@ 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` @@ -17,7 +17,7 @@ The application will be available at `http://localhost:8080` To stop the application: ```bash -docker-compose down +docker compose down ``` ### Using Docker CLI @@ -114,7 +114,7 @@ docker logs stackrender Or with Docker Compose: ```bash -docker-compose logs +docker compose logs ``` ### Port Already in Use diff --git a/README.md b/README.md index 7495f64..5dd682f 100644 --- a/README.md +++ b/README.md @@ -15,16 +15,16 @@ -# 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. @@ -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 . @@ -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