mirror of
https://github.com/stackrender/stackrender.git
synced 2026-09-10 11:15:42 +00:00
Tamani Karim
99 lines
4.7 KiB
Markdown
99 lines
4.7 KiB
Markdown
|
||
|
||
|
||
<h4 align="center">
|
||
<a href="https://www.stackrender.io">
|
||
<img src="https://img.shields.io/badge/Start%20Building!-gray.svg?logo=data:image/svg+xml;base64,PHN2ZyBmaWxsPSIjRkZENzAwIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMiIgaGVpZ2h0PSIxMiIgdmlld0JveD0iMCAwIDI0IDI0Ij48cGF0aCBkPSJNMTMgMyBMMiAxMyBoNyBMMTEgMjEgTDIyIDExIGgtNyBMIDEzIDMgeiIvPjwvc3ZnPg==" alt="Start Building!" />
|
||
</a>
|
||
|
||
<a href="https://discord.com/invite/DsN8RcPR6Y">
|
||
<img src="https://img.shields.io/discord/1352085267535761448?color=5865F2&label=Discord&logo=discord&logoColor=white" alt="Discord community channel" />
|
||
</a>
|
||
<a href="https://x.com/intent/follow?screen_name=Iam_The_Dev">
|
||
<img src="https://img.shields.io/twitter/follow/Iam_The_Dev?style=social"/>
|
||
</a>
|
||
|
||
</h4>
|
||
|
||
# Welcom 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**.
|
||
|
||
## 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.
|
||
- **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
|
||
|
||
And more coming very soon!
|
||
## Get Started
|
||
|
||
Use the [cloud version](https://www.stackrender.io) or deploy locally to start designing your database schemas in minutes.
|
||
|
||
### How to Use
|
||
Install dependencies and start the development server:
|
||
```text
|
||
npm install
|
||
npm run dev
|
||
```
|
||
### How to Build
|
||
Install dependencies and start the production build:
|
||
```text
|
||
npm install
|
||
npm run start
|
||
```
|
||
## 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
|
||
|
||
- [**Discord**](https://discord.com/invite/DsN8RcPR6Y) – 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/DsN8RcPR6Y) 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.
|
||
|
||
<pre> _____ _ _ _____ _
|
||
/ ____| | | | | __ \ | |
|
||
| (___ | |_ __ _ ___| | _| |__) |___ _ __ __| | ___ _ __
|
||
\___ \| __/ _` |/ __| |/ / _ // _ \ '_ \ / _` |/ _ \ '__|
|
||
____) | || (_| | (__| <| | \ \ __/ | | | (_| | __/ |
|
||
|_____/ \__\__,_|\___|_|\_\_| \_\___|_| |_|\__,_|\___|_|
|
||
</pre>
|
||
|