secanis/stjorna repository overview

⁠STJÓRNA

STJÓRNA was created to have an easy product management with the possibility to access the categories and products over an simple just readable REST API.

⁠Features

STJÓRNA is islandic and means something like manage or store stuff. The two main goal of STJÓRNA are to be very simple in the setup and configuration effort. The second goal was to publish and share the stored data over an REST API with other applications, maybe your website.

• Availability of REST API for third-party applications
• Language support for German and English
• Possibility to export all your data as a JSON or Excel file
• Open Source software - hosted on Github

⁠Get Started

You have two possibilities how you can start/deploy STJÓRNA:

⁠Docker

You can directly pull the official Docker image from Docker Hub.

docker pull secanis/stjorna
docker run -p 80:3000 secanis/stjorna

# for persisting your data
docker run -p 80:3000 -v path/to/storage:/app/data secanis/stjorna

⁠NodeJS

Download the compressed package and unpack it in a NodeJS environment. Default Port is 3000.

# in this case your persist data will be under ./data
node server/server.js

# execute server api tests
cd server; npm run test

Do not forget to set the NodeJS production mode: process.env.NODE_ENV = 'production'!

⁠Cofiguration

For more information please have a look on our website: https://stjorna.secanis.ch⁠.

⁠Contribution

It would be very nice, when you give us a feedback or when you create issues if you detect problems or bugs. If you want to fix it yourself or you have an idea for something new, please create a PR, that would help us a lot.

Happy Coding <3 ...