1
0
mirror of https://github.com/raseels-repos/golang-saas-starter-kit.git synced 2025-06-06 23:46:29 +02:00

Added new diagram of architecture to main readme file.

This commit is contained in:
Lucas Brown 2019-07-15 00:35:29 -08:00
parent 0d42039a3c
commit efd67d2fc9
2 changed files with 11 additions and 4 deletions

View File

@ -34,12 +34,15 @@ SaaS product offerings typically provide two main components: an API and a web a
valuable software based product to clients ideally from a single code base on a recurring basis delivered over the
internet.
The example project is a complete starter kit for building SasS with GoLang. It provides three example services:
The example project is a complete starter kit for building SasS with GoLang. It provides two example services:
* Web App - Responsive web application to provide service to clients. Includes user signup and user authentication for
direct client interaction.
* Web API - REST API with JWT authentication that renders results as JSON. This allows clients to develop deep
direct client interaction via their web connected devices.
* Web API - REST API with JWT authentication that renders results as JSON. This allows clients and other third-pary companies to develop deep
integrations with the project.
* Schema - Tool for initializing of Postgres database and handles schema migration.
And these tools:
* Schema - Initializing of Postgres database and handles schema migration.
* Dev Ops - Deploying project to AWS with GitLab CI/CD.
It contains the following features:
* Minimal web application using standard html/template package.
@ -60,6 +63,10 @@ It contains the following features:
* CLI with boilerplate templates to reduce repetitive copy/pasting.
* Integration with GitLab for enterprise-level CI/CD.
Accordingly, the project architecture is illustrated with the following diagram.
![alt text](resources/images/saas-stater-kit-diagram.png "SaaS Starter Kit diagram")
### Example project
With SaaS, a client subscribes to an online service you provide them. The example project provides functionality for

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB