pawecogmbh / saaster

Saaster is a base application written in CFML that offers all the basic functionality that you need for a SaaS project.

👋 Introduction

Saaster is a base application written in CFML that offers all the basic functionality that you need for a SaaS project.

🌐 Website
📚 Documentation
📃 License

👀 Demo as a SysAdmin

Checkout our demo at demo.saaster.io

Login
User: [email protected]
Pass: testtest

👀 Demo as a customer

Register here

👀 Test demo plans:

See plans

✔️ Requirements

The following list contains all the requirements that your system hast to fulfill to run saaster. For local development we strongly recommend the usage of the docker configuration that is provided by saaster.

• MySQL 5.7
• Lucee 5.3 or greater.
• Any web server with URL rewriting support.

That's pretty much it. Saaster should run on all popular web servers and got tested with IIS and Tuckey servlet filter. The chosen web server should support URL rewriting.

👷 Local development environment

Windows:

• Docker Desktop
• WSL2 with any Distrobution for example: Ubuntu
  In Docker Desktop enable WSL Integration with the distro you choosed.
• make (Install in WSL2 distro)

🐧 Linux:

• Docker
• Docker Compose
• make

MacOS:

• Docker Desktop
• make (Install over xcode)

📥 Setup local development environment

Clone the repository

git clone https://github.com/PAWECOGmbH/saaster

Create the required config files

You can find some example config files in the "configs" folder of the repository. Copy them to the root directory of the application and rename them as followed:

config/example.cfconfig.json   ->   /.cfconfig.json
config/example.env             ->   /.env
config/example.server.json     ->   /server.json
config/example.config.cfm      ->   /config.cfm

These files should work out of the box. You can obviously change the values of these configs to your liking.

Start the application

Now you can start the application. Open any console* in the root application directory and execute the following commands:

*On Windows you need to use the WSL distro to use make. The filesystem of Windows is normally mounted under /mnt on your WSL system.

make

This will output all possible commands:

Makefile commands:
dev                     -> creates the local development environment      
reinit                  -> reinites the database
seed                    -> seeds certain sql files
clean                   -> removes full application with all containers
url                     -> outputs all importent URL's of the application

Now enter make dev and let the application build.
If everything worked out, then it should display the URL's:

------------------------------------------------------
Saaster: http://localhost/login
Mailslurper: http://localhost:9000
Lucee Admin: http://localhost/lucee/admin/server.cfm
------------------------------------------------------

Seeding MySQL files

In the directory db/dev you find some SQL files. These files provide you with example data and or basic configuration for saaster.

To execute these files, use the following make command:

make seed

Then enter the number of the sql file you would like to seed.

[1] create-modules.sql 
[2] create-notifications.sql 
[3] create-plans.sql 
[4] create-widgets.sql 
[5] create-sysadmin.sql
Choose a number: 5

Rebuild database

To completly rebuild the database, you can use the make target reinit. This command rebuilds the complete MySQL container and executes all the scripts in the db/init directory.

make reinit

Mockdata

If you need some customers or invoices while developing, you can make use of the mockdata generator we implementet.

You can access it under: /setup/mockdata/index.cfm

🔗 Dependencies

• Tabler
• Dropify
• Trumbowyg
• Bootstrap
• MockDataCFC
• Fontawesome
• jquery
• taffy

saaster's Issues

Invoices / Link to customer and user

These links need to link to the right customer / user.

Add invoice function

For admins, we should provide the possibility to create invoices manually for their customers and to modify existing invoices.

• New button "Add invoice"
• New button "Edit invoice"

To fix

• User overview: The icon in button "new user" should be a plus sign instead of a book
• If in setup is choosen "worldwide", we should change the text in currencies. Like: You have selected "Worldwide" during the setup. Therefore, you do not have to select any countries here. If you select countries, this means that you only accept customers from the selected countries.
• If there is no plan group added, the button "new plan" should be hided.
• If no country is activated, the country select in plan groups should be hided.
• Plan preview: VAT is not there
• Plan preview: Prices not correct (Free everywhere)

In user settings you are able to select only superadmin, even tho you can't have this role without the admin role

After saving / submitting the values are correctly written in the database. Yet I think it is visually misleading.

Wrong link in action drop down on users list

On the page where we can add or edit users, there is a dropdown with diffrent links. The link "Edit" of my own entry goes to the user edit page. But it must link to the personal profile!

Beautify jQueries / JS

Everywhere .. you know what I mean ;)

Change presentation of "Default value" and "Description" under /sysadmin/settings

Currently

Expected

Account overview for Admins

When I have admin rights (only blnAdmin is true), then I see the entry "Tenants" in the Account Setitings overview. But if I click on it, then I see the error message that I dont have access to the section. Biute in the overview we should remove the entry "Tenants" for only Admins.

When user already exists in optin table delete old record

After the registration process we are waiting on the form with the message "a link has been sent...". If this link doesn't find the way to the mailbox, it should be possible to resend the link.

Title of widgets is not defined

On the site /sysadmin/widgets the title of the page is not defined / not translated.

Under "Account settings" the title of modules is hardcoded in german

Choose language while registering

In the register form we should implement also the language in order to display the correct language after the login...

Connect invoice and plans/modules

In order to activate a plan or a module, the SysAdmin should also be able to create an invoice via the backend, which is linked to the plan or module. As soon as the invoice has been paid by the client, the plan or module is automatically activated.

Improve tables with action button

We have added many tables, among others for the invoices. If there are only one or two invoices, the action button is hidden behind the table when opening. This needs to be improved:
account-settings/invoices
account-settings/users
account-settings/tenants
sysadmin/invoices

Setting timezones and date formatting

We need to implement the timezones. Depending on where the user is or what his settings are, a different time and format must be displayed.

If a plan is upgraded or downgraded, it needs to be recalculated.

In the customer account, it is possible to downgrade or upgrade a booked plan. Currently, a new invoice is simply created without charging or refunding the customer for the price difference. This still needs to be done.

Translate bug in invoice

The text "Invoice total" is EN all the time, doesn't matter which language the user has set.

Setup routine must be improved

It's not needed to choose the default country, because there is the option "worldwide"... and other stuff...

While registering: The company name should not be required

Question: Better registering without the company name?

The "Modules" feature must be improved

If a user changes his email address, we should first send him an email in order to confirm the new address

Wrong include in plans

When no plans exists, a file that should not be includet, gets includet.

Redirect user after first login

The user should complete his/her data after the first login. Send the main user (first user) to the company settings and all later users to his/her profile.

Invoices for customers: display payments

In the detail view of invoices we should display the payments too.

Building the scheduled task

We nedd a scheduler running regularly. Following tasks must be done:

1: Invoices with overdue date -> update the status
2: Deleting of personal data after a plan or module is canceled and the end date is reached
3: Renew plans and modules via Payrexx

Invoices: Needs a click to continue

The Invoices for users (not sysadmin) needs a function which shows only 20 invoices. Then there should be a link to show the next 20 entries. Same function as for customers under sysadmin.

Sysadmin Customers doesn't check if you are allowed to see the user

/sysadmin/customers/details/202

Bug in Countries: Wrong name when default language is not EN

If I choose German as my default language, I can't translate the name of the country to German. The country name eg. for Switzerland is therefore "Switzerland" instead "Schweiz".

After adding a new language not possible to translate a plan

I have added a new language. After that, I wanted to translate a plan description. The error is: Field 'strPlanName' doesn't have a default value

We need a currency sign in the currency module

For example: $ for Dollar etc...

Adding customers by sysadmin?

Shall we implement the function to add customers via sysadmin account?

Add customers feature for sysadmin

Should display all customers in a table

• Detailpage
• Edit function
• Sorting function
• Search function

A module included in a plan must be canceled too if a plan is canceled

After changing the tenant, the tenant name is empty

After adding a tenant we can change the tenant using the dropdown at the top. But then we loose the tenants session -> edit company is empty...

Book a module

The function "book a module" must still be done.

Dashboard with Drag'n'Drop function

It should be possible to move the widgets on the dashboard for every user.

Change a plan

The function "change" a plan is not implemented yet.

Implement Payment Service Provider

We need to implement the PSP Payrexx

Invoices are displayed for all clients

Only invoices of the current client may be displayed.

When you delete the second last language it throws a error

For example when german is default and english is alternative one and you delete the english language it will throw following error:

Beautify emails

We need a template for emails such as the registering email. All links should changed to a button.

getSettings must be improved

The function getSetting in global.cfc must be improved, because it is loaded many times. We should do it like the language: Save it into a struct and load via application scope.

Bug in sysadmin / customer edit

The bug appeared after we changed the timezon stuff. Generally we need to rewrite the customer query, better making a struct.
I have commented the country name in customers_detail.cfm

Making mail styles dynamic

In the file /includes/mail_dsign.cfm the variables are static at the moment. We could use the system_settings in order to save the colors and styles.

Building of Landingpages

For the creation of landingpages, we could implement the toolbox from FROALA: https://github.com/froala/design-blocks
Please study it and think about how we could implement it in saaster. Or would there be even better solutions?

Login as customer

We could realise a function in order to login as a customer/user. Just click a button on the user overview "Login as this user".

Sort plans within groups

The plans have a table with a sorting function (intPrio). These still need to be programmed so that they can be sorted separately into groups. The list should also be group-separated.

Small bugs that need to be fixed

1. On the site /sysadmin/widgets the title of the page is not defined / not translated.

2. Bug in all paginations. You can manually enter negative and to big values in the url key start.
Concerns following pages:

• /sysadmin/customers
• /sysadmin/invoices
• /sysadmin/countries

**3. If I only have one language and I also have an invoice, there is an error ocurring:

Beautify design for plan comparison

I have already created all the code for this table and also written some CSS, but it still needs to be optimised. You have already received the template via Skype (link).
http://localhost/plans

Down- or upgrade a plan

The function to down- or upgrade a plan is not yet implemented. Question: What shall we do, whe a user wants to downgrade? Do we give him a credit? Or has he lost his money? What do we do when he wants to upgrade the plan, do we charge for the money already paid?

The function could be implemented in /frontend/book.cfm at line 90