From ac25dc6c1a74fd332f180946d6e8a914cd07da2c Mon Sep 17 00:00:00 2001 From: ocueye Date: Wed, 20 Nov 2024 16:22:19 +0000 Subject: [PATCH] added dev to readme --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 4e85455..d257758 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,34 @@ Here to there is a open source, self hosted verson I made of send anywhere. It allows you to upload files and retreve them via a code to easily. solving the problem of how to transfer your files from one device to another. I made it because all of the options eather have ads, only work on the lan, or cost on a subscription basis. A nas also seems overkill for a problem like this. + +## To Run + +(This is desined to be run on linux) + +### linux +to run this program, make a venv virtual enviroment and run `pip install cherrypy` and then run `start.py`. +### docker +just clone this repo + + +## ToDo +- [ ] make file ids use avalible random numbers + +# for devs +## start.py +`start.py` contains all of the backend stuff. + +## uploads +The `uploads` folder contains all of the files being transfered + +The uploads folders structure is as follows + +- uploads + - 1 + - file with id 1 + - 2 + - file with id 2 + +## webpage +this folder contains all of the html templates that htt uses. \ No newline at end of file