pika/markdownViewer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: addet readme stuff and addet requirements.txt file for easy project initialisation

Browse source
This commit is contained in:
piecka 2025-03-21 11:27:37 +01:00
parent 61a3cb2ff4
commit 339c75cfb1
2 changed files with 21 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,11 +1,27 @@
## flask markdownViewer ## flask markdownViewer
### running the project
##### **Dependencies**
- python3
```bash
git clone https://git.k4li.de/pika/markdownViewer.git && cd markdownViewer
pip install -r requirements.txt
python3 run.py
```
> Just clone the repo, install the dependencies by the requirements.txt file and run the webapp!
### features ### features
- **Upload your markdown files and display them in a styled way** - **Upload your markdown files and display them in a styled way**
- **Host links or files for display purposes** - **Host links or files for display purposes**
#### todo ## todo
- **Login**: Make it, so that you can only add new things when logged in - **Login**: Make it, so that you can only add new things when logged in
- **Update**: Update current markdown files to display new content - **Update**: Update current markdown files to display new content

4
requirements.txt Normal file
View file

@ -0,0 +1,4 @@
flask
flask-sqlalchemy
flask-login
markdown