chopster44/GiacPoints
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added installation instructions

Browse Source
This commit is contained in:
chopster44
2023-07-22 21:42:40 +01:00
parent 3506af77bf
commit 46cc0237ce
3 changed files with 5 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,11 +1,8 @@
# GiacPoints
A system for keeping track of house chores completed and attributing points to the activities.
# Functionality
Webpage - Login, add chores/activities (admin), tick of chores (user), log of completed chores (all)
API layer - /loginUser, /getTasks, /completeTask, /getHistory?filter, /addTask
Backend - DB, user (name password userid role), activities (taskid name points), history (userid taskid time pointsGained)
# Installation
`Note: Linux only`
1. Clone this repo
2. rename `database/example.db` to `database/data.db`
3. Execute `main`