diff --git a/README.md b/README.md index e03a3fb7b18bb9743241cac1f7c78a22361a8559..256d9dab28c4f86dfc8b0b7d08ca2db7b53ee165 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,72 @@ # First steps to UniSport-O-Mat ## Some notes -To ensure a clean development and production environment, we will use `virtualenv`. If you have not installed or used it yet, please reffer to the [official documentation](https://pypi.org/project/virtualenv/). + +To ensure a clean development and production environment, we will use `virtualenv`. If you have not installed or used it yet, please refer to the [official documentation](https://pypi.org/project/virtualenv/). ## Starting `virtualenv` + First create a new folder, in which you want to give this project a new home. Then, create a new `virtualenv` via this command in your terminal + ``` virtualenv -p python3 . ``` + You'll see a few new folders and a config file for your `virtualenv`. You can start the new environment via this command in your terminal, depending on your OS. Linux/MacOS: + ``` source bin/activate ``` + Windows + ``` Scripts/activate ``` + If done correctly, you'll see the name of the virtual environment printed at the beginning of your command promt, eg. in bash: + ``` (unisport-o-mat) 18:57:55 [foo@bar unisport-o-mat]$ ``` ## Cloning the project + To clone the project via `git`, please enter one of these commands via your terminal, depending on your preferred way to authenticate. Via HTTPS: + ``` git clone https://git.imp.fu-berlin.de/swp-unisport/team-warumkeinrust/unisport-o-mat.git ``` Via ssh: + ``` git clone git@git.imp.fu-berlin.de:swp-unisport/team-warumkeinrust/unisport-o-mat.git ``` ## Installing dependencies + You can verify that no python libraries are installed in your `virtualenv`, if you enter the following command via terminal. It should not return any modules right now. + ``` python -m pip freeze ``` All required dependency, such as Django, will be installed via `pip` and a text file, such as `requirements.txt`. First, switch the current directory via `cd` into the cloned folder. Then, install the dependencies all at once via this command in your terminal. + ``` python -m pip install -r requirements.txt ``` ## Starting the django web server + To start the web server, change the directory via `cd` in the project folder. Here you will find the `manage.py` script, which will be used to start commands depending on the Django framework. Start the web server via this command in your terminal. + ``` python manage.py runserver ``` -If successful, you can now see the running server in your browser at `http://127.0.0.1:8000`. \ No newline at end of file + +If successful, you can now see the running server in your browser at `http://127.0.0.1:8000`. diff --git a/unisportomat/unisportomat/__pycache__/__init__.cpython-38.pyc b/unisportomat/unisportomat/__pycache__/__init__.cpython-38.pyc deleted file mode 100644 index dcc6f9bc83179356712c1daa11fdf86d334060fc..0000000000000000000000000000000000000000 Binary files a/unisportomat/unisportomat/__pycache__/__init__.cpython-38.pyc and /dev/null differ diff --git a/unisportomat/unisportomat/__pycache__/settings.cpython-38.pyc b/unisportomat/unisportomat/__pycache__/settings.cpython-38.pyc deleted file mode 100644 index 2e550a5112ce738b8fd0dbb5048aae5dbf71aab3..0000000000000000000000000000000000000000 Binary files a/unisportomat/unisportomat/__pycache__/settings.cpython-38.pyc and /dev/null differ