diff --git a/README.md b/README.md index f18ef42..445ccd0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,23 @@ -#GRABBER +# GRABBER -Grabber is a script that "grabs" informations about the computer and puts them in a folder for ease of access. +Grabber is a program that "grabs" informations about the computer. You can then acces this information from a web page. It can also grab employee data which you can add/delete through a formulaire page, stored in SQL, which can be used later for many to many connection. Users can be assigned to one or more computers. -##How to run a server +## How to run the server + +First you should run a virtualised environment +`source gbvenv/bin/activate` + +Then start the server with uvicorn `uvicorn app:app --reload --host 0.0.0.0 --port 8000` + +You should now be able to visualize the pages after running `sudo bash grabber.sh localhost` on your localhost:8000. + +**Pages references:** +localhost:8000/ordi/{id} **"List of information on the computer"** +localhost:8000/employees **"List of employees"** +localhost:8000/employee/create **"Formulaire to add an employee"** +localhost:8000/employee/{id}/delete **"Delete selected employee"** + + +