Openjur
Open implementation of the winjur timesheet system using svelte, sqlite, and electron, written in typescript.
Getting Started
These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. For builds, please see the releases tab.
Prerequisites
Requirements for the software and other tools. I highly recommend using yarn.
Installing
A step by step series of examples that tell you how to get a development environment running
Install dependencies
yarn install
Run the project locally
yarn electron:dev
Running the tests
There are currently svelte and style tests. These are run in a pre-commit hook thanks to husky.
Svelte test
Checks if the svelte code can be compiled.
yarn check-svelte
Style test
Checks if the right coding style has been used.
yarn check-format
To automatically fix style issues
yarn format
Contributing
Please read through the issues and comment on one you are interested in. Make sure you run the checks before you submit a pull request. Technical documentation can be found in the docs folder. A roadmap of future features can be found here.
Versioning
We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.
