Please report any bugs or feature requests to the GitHub issue tracker or write us a mail.
Contributions very much welcome! Feel free to write us a mail if you have any questions or just open a new issue. Don't forget to check out the project documentation.
Follow the next steps if you want to develop/build locally.
cd web/
# install correct node version (might be optional)
nvm install
# install dependencies
npm install
# Either run with the remote API (at spluseins.de/api)
npm run dev:remote
# Or use the local API, when developing the backend (see below)
npm run dev:local
cd server/
Add your ostfalia credentials as environment variables, preferably in a .env
-file.
# ./server/.env
SKED_USER=idxxxxxx
SKED_PASSWORD=your_ostfalia_pw
# install dependencies
npm install
# install correct node version (might be optional)
nvm install
# Set environment variables
CACHE_PATH=spluseins-cache # Linux/Unix
set CACHE_PATH=spluseins-cache # Windows
# start dev api at localhost:3001/api
npm run dev
cd docs/
# install dependencies
npm install
# serve docs at http://localhost:8080/docs/
npm run dev