https://github.com/go-saas/saas
go data framework for saas(multi-tenancy)
https://github.com/go-saas/saas
gin golang kratos multi-tenancy saas tenant
Last synced: about 2 months ago
JSON representation
go data framework for saas(multi-tenancy)
- Host: GitHub
- URL: https://github.com/go-saas/saas
- Owner: go-saas
- License: mit
- Created: 2020-11-18T19:33:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T08:54:59.000Z (about 1 year ago)
- Last Synced: 2025-03-29T08:11:15.560Z (about 2 months ago)
- Topics: gin, golang, kratos, multi-tenancy, saas, tenant
- Language: Go
- Homepage:
- Size: 981 KB
- Stars: 284
- Watchers: 8
- Forks: 46
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-saas
[English](./README.md) | [中文文档](./README_zh_Hans.md)
headless go framework for saas(multi-tenancy).
`go-saas` targets to provide saas solution for go
this project suits for simple (web) project, which is also called monolithic.
if you are finding complete solution which is microservice compatible, please refer to [go-saas-kit](https://github.com/go-saas/kit)
# Overview
## Feature
* Different database architecture
* [x] Single-tenancy: Each database stores data from only one tenant.
* [x] Multi-tenancy: Each database stores data from multiple separate tenants (with mechanisms to protect data privacy).
* [x] Hybrid tenancy models are also available.
* [x] Implement your own resolver to achieve style like sharding
* Support multiple web framework
* [x] [gin](https://github.com/gin-gonic/gin)
* [x] [iris](https://github.com/kataras/iris)
* [x] net/http
* [x] [kratos](https://github.com/go-kratos/kratos)
* Supported orm with data filter, which means all underlying database
* [x] [gorm](https://github.com/go-gorm/gorm)
* [x] [ent](https://entgo.io/)
* Customizable tenant resolver
* [x] Query String
* [x] Form parameters
* [x] Header
* [x] Cookie
* [x] Domain format
* Seed and Migration
* [x] Seed/Migrate tenant database after creation or upgrade to new version
* Integration with gateway
* [x] [apisix](https://github.com/apache/apisix)
## Install
```
go get github.com/go-saas/saas
```
## Design
```mermaid
graph TD
A(InComming Request) -->|cookie,domain,form,header,query...|B(TenantResolver)
B --> C(Tenant Context) --> D(ConnectionString Resolver)
D --> E(Tenant 1) --> J(Data Filter) --> H(Shared Database)
D --> F(Tenant 2) --> J
D --> G(Tenant 3) --> I(Tenant 3 Database)
```
# Sample Project
* [example-gorm](https://github.com/go-saas/saas/tree/main/examples/gorm) combination of `go-saas`,`gin`,`gorm(sqlite/mysql)`
* [example-ent](https://github.com/go-saas/saas/tree/main/examples/ent) combination of `go-saas`,`gin`,`ent(sqlite)`
* [go-saas-kit](https://github.com/go-saas/kit) Microservice architecture starter kit for golang sass project
# Documentation
Refer to [wiki](https://github.com/go-saas/saas/wiki)
# References
https://docs.microsoft.com/en-us/azure/azure-sql/database/saas-tenancy-app-design-patterns