Kailona is currently under alpha development. Any contribution such as platform improvements, new plugins, documentation, testing, translation, etc. would be greatly appreciated.
Please read this section to learn the architecture and project structure.
Please read our code of conduct for better understanding of what actions will or will not be tolerated.
There are many ways to contribute to Kailona. Please join our forum here
- Please search the existing issues first, it's likely that your issue was already reported or even fixed.
- Go to one of the repositories, click "issues" and type any word in the top search/command bar.
- You can also filter by appending e.g. "state:open" to the search string.
- More info on search syntax within github
- This repository EHR is only for issues within the Kailona app.
Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
We use the Developer Certificate of Origin (DCO) as a additional safeguard for the Nextcloud EHR project. This is a well established and widely used mechanism to assure contributors have confirmed their right to license their contribution under the project's license. Please read contribute/developer-certificate-of-origin. If you can certify it, then just add a line to every git commit message:
Use your real name (sorry, no pseudonyms or anonymous contributions). If you set your
configs, you can sign your commit automatically with
git commit -s. You can also use git aliases like
git config --global alias.ci 'commit -s'. Now you can commit with
git ci and the commit will be signed.
See how a minor change to your commit message style can make you a better programmer.
<scope> is optional
The various types of commits:
feat: (new feature for the user, not a new feature for build script)
fix: (bug fix for the user, not a fix to a build script)
docs: (changes to the documentation)
style: (formatting, missing semi colons, etc; no production code change)
refactor: (refactoring production code, eg. renaming a variable)
test: (adding missing tests, refactoring tests; no production code change)
chore: (updating grunt tasks etc; no production code change)
Use lower case not title case!
Prettier will catch most styling issues that may exist in your code. You can check the status of
your code styling by simply running
npm run prettier.
However, there are still some styles that Prettier cannot pick up.
- Most important: Look around. Match the style you see used in the rest of the project. This includes formatting, naming files, naming things in code, naming things in documentation.
- Do not wrap lines at 80 characters - configure your editor to soft-wrap when editing documentation.
npm are required.
The app can be built using
During development the webpack dev server can be used to automatically build the code for every change.
Since the compiled source from the webpack dev server need to be injected in the regular Nextcloud sources a proxy setup is needed to combine things.
If your local Nextcloud setup runs at http://localhost:8080, an nginx configuration for the proxy would look like the following:
This will run the proxy at
With the proxy configured you can start the webpack dev server and specify where the Nextcloud proxy is.
Alternativately, Nextcloud and proxy server can be run in Docker for development using the following steps:
- Copy the content of
.developmentfolder in this repo into the
docker-compose up -din the
- Wait a bit for Nextcloud initialization
http://localhost:3001url and enable debug mode
- Clone the repo in the
PROXY_URL=http://localhost:3001/ make watch
- Go to
Electronic Health Records (EHR)application in Nextcloud
Please submit translations via Transifex.