@brezel/installer 1.0.0

package/task.md

@@ -0,0 +1,77 @@
+# Build the Brezel Installer
+
+## Objective
+Complete the Brezel installer. The installer should be able to install Brezel
+on a user's system, including all necessary dependencies and configurations. The installer should be user-friendly and
+provide clear instructions throughout the installation process. It should also include options for customizing the
+installation, such as choosing the installation directory and selecting which components to install.
+
+The docs are here: /Users/keanu/Dev/kibro/brezel/wiki/src/content/docs.
+The getting started guide is here: /Users/keanu/Dev/kibro/brezel/wiki/src/content/docs/start_here/getting_started.mdx
+The current guide is the manual installation guide because no installer is available yet.
+
+SPA is here: /Users/keanu/Dev/kibro/brezel/spa
+API is here: /Users/keanu/Dev/kibro/brezel/api
+Instance skeleton is here: /Users/keanu/Dev/kibro/brezel/brezel
+
+## Installer technology
+- Fast-track bash script install, like ´curl -sL brezel.io/install | bash`
+- The installer itself: TypeScript
+
+## Installation modes
+- Interactive mode: The installer prompts the user for input and guides them through the installation process step by step.
+- Non-interactive mode: The installer can be run with command-line arguments to specify installation options
+
+## Installation source control mode
+The user should have the option to either
+- clone the skeleton repo **without git history** or 
+- fork and clone the skeleton repo.
+
+## Installation manner
+- Bare metal: The installer sets up Brezel on a fresh server or local machine, including all necessary dependencies and configurations.
+- Containerized: The installer sets up Brezel in a containerized environment, such as Docker, to simplify deployment and ensure consistency across different environments.
+
+## Installation target
+- Linux: The installer must work on Linux-based systems, which are commonly used for server deployments.
+- macOS: The installer must also work on macOS for local development purposes.
+- Windows: The installer should ideally support Windows, but it can be a secondary priority due to the complexities of Windows environments. A separate installer or script may be needed for Windows.
+
+## Optional components
+- Database: The installer can include an option to set up a database (must be strictly MariDB) for Brezel.
+- Web server: The installer can include an option to set up a web server (e.g., Nginx) to serve the Brezel application.
+- SSL: The installer can include an option to set up SSL certificates for secure communication.
+- Cron jobs: The installer can include an option to set up cron jobs for scheduled tasks in Brezel.
+- Brezel services
+  - @kibro/brezel-export-installer a sub installer for the export service, which is a separate service that needs to be installed and configured.
+  - more to come
+
+## About Brezel: a quick overview
+Brezel is an ERP system that is designed to be easy to use and customizable.
+It is built on top of Laravel and Vue/Vite.
+A standalone Brezel **instance** looks like the skeleton https://github.com/brezelio/brezel.
+It uses @kibro/brezel-spa for the SPA and brezel/api as the Laravel-based API backend.
+
+In the backend, Brezel provides a framework for building modules, which are the 
+building blocks of a Brezel application. 
+A module defines the data schema for a specific feature (e.g., Blog Posts, Products, Users).
+A module has fields, which are the individual data points that make up the module (e.g., title, description, price).
+A module also has an index layout, which defines how the module's data is displayed in a list view, and a detail layout, which defines how the module's data is displayed in a view/create/edit form.
+Business logic is defined in JSON-based workflow files.
+
+### Instances, Systems, and Clients
+A Brezel **instance** encapsulates the complete configuration inside one or more **systems** (i.e. tenants).
+
+Each **system** is defined in `systems/<system>` and has its own database.
+Usually, a Brezel instance will have one system, but it can support multiple systems if needed.
+A brezel **system** needs a standard set of modules: clients, users, roles, and files.
+
+A **client** is a tenant inside a system, used to separate entities from each other. For example, if you are building a CRM for multiple companies, each company would be a client in the same system. Clients share the same database and modules, but their data is separated by a `client_id` field.
+
+### Main CLI interface after installation:
+- `php bakery system create <system-name>`: Creates a new system with the specified name.
+- `php bakery init`: Bootstraps and migrates the meta database and creates the necessary tables for managing systems.
+- `php bakery migrate`: Runs the database migrations for the current system, ensuring that the database schema is up to date with the latest Brezel version.
+- `php bakery apply`: Plans the configuration from the `.bake` files to the database, creating tables, fields, and default data as defined in the configuration files.
+- `php bakery apply`: Applies the configuration from the `.bake` files to the database, creating tables, fields, and default data as defined in the configuration files.
+- `php bakery load`: Loads workflows into the database.
+- `npm run dev`: Starts the development server for the SPA, allowing you to access the Brezel application in your browser and see changes in real-time as you develop.

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "outDir": "./dist"
+  },
+  "include": ["src/**/*"]
+}