Getting Started
Development with ValkyrAI is simple once you get the hang of the CodeGen development practices. We recommend you review the development best practices before getting too far into development.
The ValkyrAI Development Best Practices Manual
System Requirements
If you need to install this software before you begin, ensure you have at least the following minimum installed:
ValkyrAI for development you will need:
- Linux/Windows/MacOS with Java 17+ @OpenJDK17+ installed
- 2GB available RAM
- working node and npm (for TypeScript client development): Download Node.js
- working git installed / github account and credentials
- working maven installed
- recommended: docker desktop
Deploying generated ValkyrAI apps requires a minimum:
- Linux/Windows/MacOS server with Java 17+ @OpenJDK17+ installed
- 2GB available RAM
Install Java Development Kit (JDK)
While ThorAPI and ValkyrAI are compatible with Java 11+, we recommend using the latest tested version available:
Download JDK v23 (recommended version) From Oracle
On MacOS you would typically brew install command.
# in re newer versions we have tested up to 23
brew install java23
Once you have java installed, you can grab maven and be up and running.
-
Apache Maven 3.6 or higher: Download Maven
-
Java Development Kit (JDK) 11 or higher: Download JDK
-
Node.js and npm (for TypeScript client development): Download Node.js
-
ThorAPI Enhancer tool: Available from the ThorAPI repository.
NOTE: there is a Maven build option to install and run the node generated stack -- and to automate the building of Typescript client library. However in practice this is a very slow step and hinders iteration time while developing the backend services that actually require a build step.
NOTE: There are definite best practices to adopt in terms of project setup, development methods, and how to manage front-end vs. backend development.