From 1fbbcf7183003398c581b28068be2cbeb9d99221 Mon Sep 17 00:00:00 2001 From: awnbck Date: Sun, 4 Oct 2020 19:40:34 +0200 Subject: [PATCH] Create README.md --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..954b329 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# 3dev-fullstack +Learn Fullstack + +## how to use the repository +### 1. first you will need to install git and node +``` +https://git-scm.com/downloads +https://nodejs.org/en/ +``` +### 2. clone the repository +now you can use git to clone this repository and get it so you have it locally on your machine as physical files +for this go to your desired directory where you want to have your files and run the following command +``` +git clone https://github.com/threedevs/3dev-fullstack.git +``` +you should now see a folder 3dev-fullstack +### 3. install the dependencies +open the folder 3dev-fullstack and install the packages that we need with following command from the npm registry +``` +npm i +``` +### 4. run the server +now you should be able to run the node server with nodemon which keeps track of changes and restarts the server if needed +``` +nodemon server +``` +### 5. run the frontend +now we can try using our server, for this open the frontend folder and run index.html in any way + +### 6. done!