From b3dbeea73f5ad82711463220c269c8fb31164ef5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20T=C3=B6rnqvist?= <simon.tornqvist@liu.se> Date: Sat, 9 Sep 2023 19:10:50 +0200 Subject: [PATCH] update readme --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c445c5b..6538234 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ -This repository was created with the following commands: +This proof of concept application was created using the node package ```create-react-app```: ```bash +# Assuming you have node and npm installed npm install -g create-react-app npx create-react-app app ``` ```npm install -g create-react-app``` installs the node package ```create-react-app``` globally on your user. ```create-react-app``` is a tool for setting up React apps in an easy way. -If you are not allowed to install packages globally, you can install the package locally by removing the ```-g``` flag: ```npm install create-react-app```. However, this will install the package in your current directory. After running ```npx create-react-app app``` there is no further use for the package. If you installed the package locally, you probably want to remove it after it has set up your app. You can do this by removing the files ```package.json```, ```package-lock.json``` and the directory ```node_modules``` from the directory you ran ```npm install create-react-app```. +If you are not allowed to install packages globally, you can install the package locally by removing the ```-g``` flag: ```npm install create-react-app```. However, this will install the package in your current directory. After running ```npx create-react-app app``` there is no further use for the package. If you installed the package locally, you probably want to remove it after it has set up your app. You can do this by removing the files ```package.json```, ```package-lock.json``` and the directory ```node_modules``` from the directory you ran ```npm install create-react-app``` in. OBS: do not remove these files from within the ```app/``` directory. These files are strictly necessary. After setting up the app your directory should contain the directory ```app/```. -- GitLab