👋 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