From 8509508a5bbba1d635f70debad9f11fbe3ca33c0 Mon Sep 17 00:00:00 2001 From: chae Date: Sun, 11 Dec 2022 16:32:09 +0100 Subject: [PATCH] first part of documentation --- README copy.md | 22 ++++++++++++++++++++++ README.md | 40 ++++++++++++++++++++++++++++------------ TODO.md | 2 ++ 3 files changed, 52 insertions(+), 12 deletions(-) create mode 100644 README copy.md create mode 100644 TODO.md diff --git a/README copy.md b/README copy.md new file mode 100644 index 0000000..1f99913 --- /dev/null +++ b/README copy.md @@ -0,0 +1,22 @@ +# Flask example + +This is a Flask example that you can use to make web applications. + +## Install + +You need to install Flask on your computer (or on the server you are working): + +`$ pip3 install flask` + +## Run the web application + +You can run the example application in different ways, here two examples: + +* `$ python3 app.py` +* `$ flask --debug run` + +## Documentation + +* +* + diff --git a/README.md b/README.md index 1f99913..2633488 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,38 @@ -# Flask example +# Flask +Flask is --- (2 sentences) -This is a Flask example that you can use to make web applications. +## SET UP -## Install +First clone the repository (aka repo) -You need to install Flask on your computer (or on the server you are working): +```git clone https://git.xpub.nl/manetta/flask-example.git``` -`$ pip3 install flask` +then move in to the folder -## Run the web application +```cd flask-example``` -You can run the example application in different ways, here two examples: +Create virtual environment (need explanation what is virtual environment and why this is needed `---> wiki⛄︎`) +This will create a virtual environment in a folder called venv. +(the first venv is the command, the second venv is the name of the folder) -* `$ python3 app.py` -* `$ flask --debug run` +[Virtual Environment](wiki/Home_hello) -## Documentation -* -* +```python3 -m venv venv``` +Install requirements. +We are taking the list of packages to install from a file called `requirements.txt` (maybe more on that in the wiki?) + +```pip install -r requirements.txt``` + +## RUN LOCALLY + +- run python + + +## RUN GLOBALLY..? + +## How to manage Locally and globally +use git + + \ No newline at end of file diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..2308eab --- /dev/null +++ b/TODO.md @@ -0,0 +1,2 @@ +What is markdown file? +Put drawings and ascii art inside README