Vispana is developed using Java and React.
You can contribute to Vispana through code, documentation or bug reports.
For bug reports, make sure you:
- Give enough details regarding your setup
- Include versions for Vespa and Vispana
- Describe steps to reproduce the error, the error itself and expected behaviour
If you're new to Java and React development, you'll need to set up your system.
More specifically, Vispana requires Java 21 to run.
- Install Java 21 or newer.
- Consider using SDKMAN! to manage all your java versions.
- You may not need to install NodeJS directly in your machine since the build process in maven
should allow you to run the application. However, if you want to run commands such as
npm run watchyou can install NodeJS from here.- Consider using a version manager like nvm.
NOTE: If you run locally, in your preferred IDE, make sure to enable the Preview features from Java 21.
To run locally, execute:
<vispana-root-folder> ./start.shThe service will be available at localhost:4000 from your browser.
To enable hot reloading of the web application, make sure you have NodeJS installed and execute:
npm run watchWe advise to add scope to the beginning of git commit message, as the release process rely on it for automatically generating the semantic version.
Possible scopes:
feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing tests
chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
Upon merges to master, Vispana will automatically generate a new image in Docker hub.