diff --git a/.gitignore b/.gitignore index d70543e..0d813f1 100644 --- a/.gitignore +++ b/.gitignore @@ -126,7 +126,6 @@ dist # vuepress v2.x temp and cache directory .temp -.cache # Docusaurus cache and generated files .docusaurus diff --git a/README.md b/README.md index c39cca2..bdd29c0 100644 --- a/README.md +++ b/README.md @@ -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` \ No newline at end of file diff --git a/database/example.db b/database/example.db new file mode 100644 index 0000000..2e12d30 Binary files /dev/null and b/database/example.db differ