added dev to readme
This commit is contained in:
parent
2e1a9408ca
commit
ac25dc6c1a
31
README.md
31
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.
|
Loading…
x
Reference in New Issue
Block a user