The skyve project contains a Readme at github.com/skyvers/skyve with useful information for getting started, configuring Spring security and other steps to get you started.
You can also follow the instructions provided in the video at the Skyve Foundry - Skyve Project Creator
Creating a new Skyve project
Before you start
Install Eclipse or an alternative Java based Integrated Development Environment and an application server. Detailed instructions are available in the Skyve Readme at github.com/skyvers/skyve.
- Use the Project Creator https://foundry.skyve.org/foundry/project.xhtml to create a Skyve project download and receive the link to the file via email.
- Import the project as a maven project and run the Generate Domain run configuration.
- Configure your application instance via the
.jsonproperties file, ensure you identify a file location for content, nominate an environment identifier (e.g. “dev”)
- Configure the application
-ds.xmlfile for connection properties to your preferred database.
- Log into your application at
localhost:8080/<projectName>with your bootstrap credentials and begin using the no-code application.
To get started, go to the project creation page (at foundry.skyve.org/foundry/project.xhtml). The project creator will create a configured Java project, set up for maven dependency management, for common development environments like Eclipse and IntelliJ.
- Enter your email address (so you can be notified when the project is created and ready to download) and give your project a name.
- Skyve supports multi-tennanted applications - so all data is secured against a customer or client name. Just enter your organisation name.
- Next choose the type of database you want for structured data - if you’re not sure, the H2 file-based option is an easy way to get started - and you can change to something else later.
- Finally, if you’ve got a Skyve Script you can add it here. If you don’t, just leave this blank.
- Create your project, and in about 1 minute, you’ll receive an email with a download link.
- Once you receive the email, use the link to download your project, and unzip it to your Java workspace.
- From your development environment, import the project as a maven project.
Configuring your new project
Add the project to your Wildfly server (in the Eclipse server window).
The project contains two configuration files - a data source xml and a project properties json file (for example
myApplication-ds.xml. Copy these into the Wildfly standalone deployment folder.
Now, create a folder for your noSQL data store - which will hold your content attachments and images. Skyve backups will also be placed here. You can place it anywhere, but its best to place it outside of your project, so that Eclipse doesn’t waste time scanning it for changes. Then update the project json configuration to match that location.
If you’re using SQL Server, you’ll need to configure Wildfly by placing the jdbc jar and windows authentication dll in place. And if you’ve chosen to use MySQL or SQL Server, you’ll also need to go and create an empty database - but if you’re using H2, you can skip this step.
Don’t worry about creating tables, Skyve will do that for your when you first deploy - for now, just update your datasource xml to match your local configuration.
Finally, run the Generate Domain target to build your project and resolve all dependencies.
Deploying your new project and logging in
Start your wildfly server.
Right click your project in the server tree and publish - Skyve will automatically create all the tables your database needs for you. Your project properties
.json file includes a bootstrap user - this is a user credential which will be automatically injected into your database so you can log in. Note that the bootstrap user is disabled if you’re in a production environment (i.e. if the setting is environment
identifier: null) - the bootstrap user is only for getting started.
Once your project is running, go to your local context and login in.
Detailed instructions are available in the Skyve Readme at github.com/skyvers/skyve.
A group is a combination of module-specific roles typically combined to represent a user access profile related to a business access profile.
Typically (not always) users will require a combination of roles to be able to access Skyve applications, for example, a back-end (staff) user may require:
- basic user privileges to the admin module to be able to manage their own user account, change password and contact details and view contact details of other back end users
- a role declared in the module(s) for your custom application.
The Skyve User Guide provides detailed steps for creating groups and users.
The roles configured by default for the Skyve admin module are as follows:
|Anonymous||Access anonymous (not logged in) public features|
|AppUser||The App User role is intended for retail and public users interacting through the “front office”. These users are assumed to operate within their own scope and have only visibility to their own data. App Users can create their own contacts, and change their own passwords.||Manage own contact details and password|
|AuditManager||Manage the activity audit log|
|BasicUser||The intention of Basic User role is to provide basic capability to back-office users. The role is for a typical office situation where users collaborate within the “Customer” scope on key application areas. For example, shared contact management, common document number serials and the ability to use Skyve’s basic personal efficiency and automation capabilities, Tags, Snapshots, Communication and view dashboards.||General access to the administration module|
|ContactManager||Allows atomic control over management of, and interaction with, contacts.||Manage contact details and interactions|
|ContactViewer||Allows atomic control over visibility of contacts.||View-only access to contact details|
|DevOps||Generate Skyve designs and metadata and administer technical aspects of the Skyve runtime|
|JobMaintainer||Allows atomic control over the ability to schedule jobs and review job progress.||Maintain Jobs|
|SecurityAdministrator||Administration of users and permissions.||Allows administration of Users and Groups|
|ViewUser||The view user is intended as a read-only office user, with visibility as per Basic User role.||View-only access to the administration module|
Groups can be further combined on a per user basis and user creation provides for selection of groups.
Roles can also be combined for customer-specific combinations, however these combinations are set at design-time by the developer. For more information see the developer guide.