đ ī¸Local development
Get a local saaster development environment running
Whether you're looking to contribute to saaster or build your own SaaS application, you'll need a development environment. We recommend using the dockerized development environment provided by saaster. The following guide will take you through the steps to set up your development environment and get you ready to start building.
Prerequisites
Windows:
make (Install in WSL2 distro)
Linux:
Docker
Docker Compose
make
MacOS:
make (Install over xcode)
Setup
Clone the repository
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:
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.
This will output all possible commands:
Now enter make dev
and let the application build.
If everything worked out, then it should display the URL's:
Seeding MySQL files
In the directory db/dev
you find some SQL files. These files provide you with example data and basic configuration for saaster.
To execute these files, use the following make command:
Then enter the number of the sql file you would like to seed.
We recommend using this scripts in your local development environment. The create-sysadmin
scripts adds an account with following credentials:
User
admin@saaster.io
Password
testtest
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.
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
Last updated