Skip to content

Staff hub

This is an internal project of Sotex Solutions that is used for managing staff. It is maintained by the team and is meant to be beginner friendly whilst keeping a high quality of code.

Setup

This project is meant to be cross platform and should be runnable both from Windows, (any) Linux and MacOS.

List of software needed

  1. .NET 8 - chosen SDK and Runtime for this project
  2. python - if you opt for pyenv you can use that to install any version of python so this can be skipped
  3. (Optional) pyenv - python version management system, it isn't supported for Windows, but there is a fork which adds that support here
  4. poetry - python dependency management system, used for creating environments and easier porting to different platforms.

Pre-commit hooks

Pre-commit hooks are a great way to have some general checks of your files locally before even creating a commit. Usually they are used to lint the code, automatically format files, and can do much much more.

# when you have python installed run the following command in the root of repository
pip install pre-commit
pre-commit install

Setup on Windows

Since Windows has a lot of incompatibilities with other operating systems its suggested to use WSL.

To install it here is a great article from Microsoft on how to do that.

NOTE: Onces the setup of WSL is complete you should add all the software from List of software needed