# 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, 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.
- **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.
### Status
StackRender is currently in **Public Beta**. Star and watch this repository to get notified of updates.
### Supported Databases
- ✅ PostgreSQL
- ✅ MySQL
- ✅ MariaDB
- ✅ SQLite
- ✅ Oracle
- ✅ SQL Server (MSSQL)
## Get Started
Use the [cloud version](https://www.stackrender.io) or deploy locally to start designing your database schemas in minutes.
### 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:
```bash
npm install
npm run dev
```
Then visit `http://localhost:3000` in your browser.
### How to Build
Install dependencies and create a production build:
```bash
npm install
npm run build
```
## Try Using It in the Cloud
1. Visit [StackRender.io](https://www.stackrender.io)
2. Click **"Launch the Web App"**
3. Pick your database
4. Import an existing database or leverage StackRender AI to create an initial database blueprint
5. Enjoy editing and viewing your database
6. Export your Database SQL DDL and run it!
## 🤝 Community
- [**Docs**](https://www.stackrender.io/docs) – Explore the StackRender docs to learn more about its features.
- [**Discord**](https://discord.com/invite/4dv26jR4Pj) – Live discussions about upcoming releases and the future of StackRender.
- [**GitHub Issues**](https://github.com/stackrender/stackrender/issues) – Report bugs and errors to help us improve your experience.
- [**X (Twitter)**](https://x.com/intent/follow?screen_name=Iam_The_Dev) – Get the latest StackRender news and updates.
## 🤲 Contributing
We welcome all contributions, whether small bug fixes or major feature additions.
- Discuss your ideas and contributions in our [Discord](https://discord.com/invite/4dv26jR4Pj) community.
- Follow the [Contributing Guide](./CONTRIBUTING.md) to get started.
- Agree to the [Code of Conduct](./CODE_OF_CONDUCT.md) to ensure a positive and respectful environment.
Every contribution helps make StackRender better, thank you for being part of the journey! ❤️
## 📜 License
StackRender is licensed under the [GNU Affero General Public License v3.0 (AGPLv3)](./LICENSE).
The next era of database engineering starts now.
_____ _ _ _____ _
/ ____| | | | | __ \ | |
| (___ | |_ __ _ ___| | _| |__) |___ _ __ __| | ___ _ __
\___ \| __/ _` |/ __| |/ / _ // _ \ '_ \ / _` |/ _ \ '__|
____) | || (_| | (__| <| | \ \ __/ | | | (_| | __/ |
|_____/ \__\__,_|\___|_|\_\_| \_\___|_| |_|\__,_|\___|_|