Download the latest release by clicking on the link and then navigating to the flip down menu "Assets". Scroll down and choose the option "Source code (zip)" which downloads a the project. Extract it to your prefered folder.
If the user wants to change name of the database which is used it can be configured in the .env file. If this is not configured the default name will be used.
DATABASE_FILENAME = user_repository.db
Before starting the program you should navigate in your terminal to the project main folder named "ot-harjoitustyo" and perform the command "poetry install" which installs all dependencies needed to run the program. After this you are ready to start the actual program with the command "poetry run invoke start".
- Run this command inside the project folder.
poetry install- Run this command to initialize or reset the database used in the program.
poetry run invoke build- Run this command to start the program.
poetry run invoke startNote: If you run into error code: "Database is locked" it may help to run the program in /tmp folder. Navigate into this folder and clode the project here. Try running steps 1, 2, 3 again from here.
When you start the program for the first time you need to create an account. The program asks for a username and a password. Both the username and password can use any combination of upper/lowercase letters, numbers and characters in "!"¤%&/()=?". Max length for both username and password is 16 characters. The username needs to be unique which the program checks automatically. The password needs to be entered two times and they need to match. After this you click the "create account button" which creates an account according to the information you have just entered and logs you in automatically.
If you already have an account you can log in straight away by entering your username and password and then clicking the "login button".
