Create an Instant App
Last updated
Last updated
Ensure You Are in a Workspace:
To create a project, you must be inside a workspace. If you just created a workspace, you should be automatically directed to its details page.
Alternatively, navigate to the "My Workspaces" tab at the top of the page and select the workspace where you want to create the project.
Add a New Project:
Once inside the workspace, click on "Add Project".
You will be presented with two options for project creation:
Blank Project: A minimal setup without a generated codebase, ideal for custom configurations.
Instant App: Generates a ready-to-use codebase, perfect for quickly starting your development with Smartr’s predefined setup.
Instant App Generation: For this guide, we will focus on the Instant App option, which provides a streamlined path to generating a codebase.
Enter Project Name: Provide a unique name for your project that reflects its purpose. Click "Proceed" to continue.
Database Settings: Choose your preferred method for connecting to the database:
Full Connection String: Enter the entire database connection string and click "Test" to verify the connection.
Manual Configuration: Specify the following:
Database Type: Select SQLSERVER.
Host: Enter the server name
If you have local SQL: host.docker.internal
If you dockirized the SQL in the Previous step: smartr-sql
Port: Optional; defaults to 1433 if not specified.
Database Name: The name of the database you intend to use.
User: The username for database access. (sa)
Password: The password for the specified user.
Click "Test" to ensure the connection is valid.
Click "Proceed" once the connection is verified.
If the connection is successful, the connection status logo will turn green, indicating that the database connection is valid.
Configure Directories: Define the directories where your project files will be stored.
Project Parent Directory: Specify the location for generated project files.
Patch History Directory: Optionally, provide a path for patch history or keep the default ([project_name]_history under the parent directory).
Auto Apply Patch: Choose whether to automatically apply patches to your database. Enable this if you want patches applied without manual intervention.
Click "Proceed" to move forward.
Generate the Codebase: Review the project settings, then click "Generate". The Smartr engine will generate your codebase based on the provided configuration.
Once the generation process is complete, the code will be available in the specified directory.
With your project successfully created, you can delve deeper into Smartr's features, codebase architecture, and learn how to add customizations.
