Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dynamiatools/module-saas
DynamiaTools extension to create multi tenant apps or software as a service
https://github.com/dynamiatools/module-saas
dynamia java multitenant-api saas tenancy zk
Last synced: 5 days ago
JSON representation
DynamiaTools extension to create multi tenant apps or software as a service
- Host: GitHub
- URL: https://github.com/dynamiatools/module-saas
- Owner: dynamiatools
- License: apache-2.0
- Created: 2019-05-13T20:45:55.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-25T15:05:21.000Z (5 months ago)
- Last Synced: 2024-06-25T16:39:00.299Z (5 months ago)
- Topics: dynamia, java, multitenant-api, saas, tenancy, zk
- Language: Java
- Homepage: https://dynamia.tools
- Size: 558 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://search.maven.org/search?q=tools.dynamia.modules.saas)
[](https://github.com/dynamiatools/module-saas/actions/workflows/maven.yml)
[](https://github.com/dynamiatools/module-saas/actions/workflows/release.yml)
# SaaS Module
This [DynamiaTools](https://www.dynamia.tools) extension allow you to create modules with multi tenant support por SaaS applications. Its manage accounts,
payments, account status, data isolation by account and more
## Modules
- Core: Entities, Services and API implementation
- API: Use this clases from your external modules
- UI: Actions and views for user interface integration.
- Remote: Allow you to check account status from external systems
## Installation
Add the following dependencies to project classpath
**Maven**
```xml
tools.dynamia.modules
tools.dynamia.modules.saas
3.1.3
```
```xml
tools.dynamia.modules
tools.dynamia.modules.saas.ui
3.1.3
```
**Gradle**
```groovy
compile 'tools.dynamia.modules:tools.dynamia.modules.saas:3.1.3'
compile 'tools.dynamia.modules:tools.dynamia.modules.saas.ui:3.1.3'
```
## Usage
The above dependencies install to your project a new DynamiaTool module called **SaaS**. From this
module you can create customer accounts, account types (plans), accounts profile and payments.
### Subdomains account based
By default, all account required a subdomain like:
- https://customer1.myapp.com
- https://customer2.myapp.com
- https://customer3.myapp.com
In your hosting provider you need to create a wildcard domain, like `*.myapp.com`
pointing to server IP using an **A RECORD**. To work local edit your `hosts` file and create multiple subdomains for
testing.
**For example**
In linux edit `/etc/hosts` file and add:
```
customer1.localhost.com 127.0.01
customer2.localhost.com 127.0.01
customer3.localhost.com 127.0.01
```
## Integration
For your modules you only require the API dependency
```xml
tools.dynamia.modules
tools.dynamia.modules.saas.api
3.1.3
```
Then, edit JPA entities and implement the `tool.dynamia.modules.saas.api.AccountAware`
interface. Add the field `Long accountId` field. The value of this field will be automatic set up by the SaaS modules
using a `CrudListener`.
You can also make you entity to extend from the helper classes `tools.dynamia.modules.saas.jpa.SimpleEntitySaas` or from
`tools.dynamia.modules.saas.jpa.BaseEntitySaas`.
## Example:
```Java
import tool.dynamia.modules.saas.api.AccountAware;
@Entity
public class Person implements AccountAware {
@NotNull
private Long accountId;
// other fields
//getter and setters
}
```
## License
DynamiaTools SaaS is available under Apache 2 License