Merge pull request 'readme update' (#1) from readme-update into main

Reviewed-on: cgcristi/order#1
This commit is contained in:
spitkov 2024-09-08 11:14:37 +02:00
commit b323f79cb7
2 changed files with 6 additions and 2 deletions

View File

@ -16,13 +16,13 @@ As said above, this is a **simple & private** backend (app.py) and frontend (in
3. The UI is simple. 3. The UI is simple.
4. This is very easily self-hostable </br> </br> 4. This is very easily self-hostable </br> </br>
Rookie Mistake: when you self-host it, you can open it in localhost:5000, when making a file/paste/shortener don't share that localhost link, localhost is only accessible on YOUR network. - instead, u can host it with your domain. (or just use it to share files with the people on your network i guess /j) Rookie Mistake: when you self-host it, you can open it in localhost:5000, when making a file/paste/shortener don't share that localhost link, localhost is only accessible on YOUR network. - instead, u can host it with your domain.
</br> </br>
</br> </br>
5. This project is **COMPLETLY** open source. 5. This project is **COMPLETLY** open source.
</br> </br>
</br> </br>
6. You might need to install some pip packages, if you dont have them installed already: ```pip install Flask Werkzeug shortuuid python-dotenv``` 6. You might need to install some pip packages, if you dont have them installed already download this repo and go into the folder and execute ```pip -r install requirements.txt```
</br> </br>
</br> </br>
7. Demo: 7. Demo:

4
requirements.txt Normal file
View File

@ -0,0 +1,4 @@
Flask
Werkzeug
shortuuid
python-dotenv