From 2e47d2c4e952e144c5ae1472e32bf43e6738247d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maximilian=20Schwarzm=C3=BCller?= Date: Tue, 23 Mar 2021 17:39:58 +0100 Subject: [PATCH] updated readme --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0bfb5081f7..27553a38cc 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,22 @@ Code snapshots (which you find in `/code`) are there for you to compare your cod You can either view my code directly here on Github (you can open + view code files without issues here) or you download the snapshots. +The subfolders in the `/code` folder are named such that mapping them to the course lectures is straightforward. + ### Downloading code snapshots You can download all the content of a branch via the "Code" button here on Github. You can then either [clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) the repository or simply download the selected branch content as a ZIP file. **Important:** You always download the **entire branch content!** -You can then dive into the interesting folders (e.g. the individual code snapshots) locally on your hard drive. \ No newline at end of file +You can then dive into the interesting folders (e.g. the individual code snapshots) locally on your hard drive. + +### Running the attached code + +You can use the attached code simply to compare it to yours. But you can also run it. + +To run my code, navigate into a specific code snapshot folder via the `cd` command in your command prompt or terminal first. + +Then run `npm install` to install all required dependencies (this will create a `/node_modules` folder). + +**Important:** If you're using the code for a module that requires API keys or a backend (e.g. the module about sending Http requests), you'll have to use **your backend URLs** or API keys. Mine won't work (I disabled my projects). \ No newline at end of file